Skip to content

_brand.yml: logo forwarding to "bootstrap" formats #11002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 7, 2024
Merged

_brand.yml: logo forwarding to "bootstrap" formats #11002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba6730f
brand,html - forward logo information to sidebars
cscheid Oct 7, 2024
572c90b
brand,html - forward logo to navbar
cscheid Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions src/project/types/website/website-navigation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ export async function initWebsiteNavigation(project: ProjectContext) {
pageMargin,
bodyDecorators,
announcement,
} = websiteNavigationConfig(
} = await websiteNavigationConfig(
project,
);
if (
Expand Down Expand Up @@ -258,7 +258,7 @@ export async function websiteNavigationExtras(

// determine dependencies (always include baseline nav dependency)
const dependencies: FormatDependency[] = [
websiteNavigationDependency(project),
await websiteNavigationDependency(project),
];

// the contents of anything before the head
Expand All @@ -267,11 +267,13 @@ export async function websiteNavigationExtras(
// Determine any sass bundles
const sassBundles: SassBundle[] = [websiteNavigationSassBundle()];

const searchDep = websiteSearchDependency(project, source);
const searchDep = await websiteSearchDependency(project, source);
if (searchDep) {
dependencies.push(...searchDep);
sassBundles.push(websiteSearchSassBundle());
includeInHeader.push(websiteSearchIncludeInHeader(project, format, temp));
includeInHeader.push(
await websiteSearchIncludeInHeader(project, format, temp),
);
}

// Inject dashboard dependencies so they are present if necessary
Expand Down Expand Up @@ -997,7 +999,7 @@ async function sidebarsEjsData(project: ProjectContext, sidebars: Sidebar[]) {
for (let i = 0; i < sidebars.length; i++) {
ejsSidebars.push(await sidebarEjsData(project, sidebars[i]));
}
return Promise.resolve(ejsSidebars);
return ejsSidebars;
}

async function sidebarEjsData(project: ProjectContext, sidebar: Sidebar) {
Expand All @@ -1009,10 +1011,10 @@ async function sidebarEjsData(project: ProjectContext, sidebar: Sidebar) {
}

// ensure title and search are present
sidebar.title = sidebarTitle(sidebar, project) as string | undefined;
sidebar.title = await sidebarTitle(sidebar, project) as string | undefined;
sidebar.logo = resolveLogo(sidebar.logo);

const searchOpts = searchOptions(project);
const searchOpts = await searchOptions(project);
sidebar.search = sidebar.search !== undefined
? sidebar.search
: searchOpts && searchOpts.location === "sidebar"
Expand Down Expand Up @@ -1227,7 +1229,7 @@ async function navbarEjsData(
): Promise<Navbar> {
const collapse = navbar.collapse !== undefined ? !!navbar.collapse : true;

const searchOpts = searchOptions(project);
const searchOpts = await searchOptions(project);
const data: Navbar = {
...navbar,
search: searchOpts && searchOpts.location === "navbar"
Expand Down Expand Up @@ -1472,8 +1474,8 @@ function looksLikeShortCode(href: string) {
return href.startsWith("{{<") && href.endsWith(">}}");
}

function sidebarTitle(sidebar: Sidebar, project: ProjectContext) {
const { navbar } = websiteNavigationConfig(project);
async function sidebarTitle(sidebar: Sidebar, project: ProjectContext) {
const { navbar } = await websiteNavigationConfig(project);
if (sidebar.title) {
// Title was explicitly set
return sidebar.title;
Expand All @@ -1499,8 +1501,8 @@ function resolveLogo(logo?: string) {
}
}

function websiteHeadroom(project: ProjectContext) {
const { navbar, sidebars } = websiteNavigationConfig(project);
async function websiteHeadroom(project: ProjectContext) {
const { navbar, sidebars } = await websiteNavigationConfig(project);
if (navbar || sidebars?.length) {
const navbarPinned = navbar?.pinned === true;
const anySidebarPinned = sidebars &&
Expand All @@ -1525,9 +1527,9 @@ function websiteNavigationSassBundle() {
};
}

function websiteNavigationDependency(project: ProjectContext) {
async function websiteNavigationDependency(project: ProjectContext) {
const scripts = [navigationDependency("quarto-nav.js")];
if (websiteHeadroom(project)) {
if (await websiteHeadroom(project)) {
scripts.push(navigationDependency("headroom.min.js"));
}
return {
Expand Down
22 changes: 11 additions & 11 deletions src/project/types/website/website-search.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,13 +407,13 @@ export async function updateSearchIndex(

const kDefaultCollapse = 3;

export function searchOptions(
export async function searchOptions(
project: ProjectContext,
): SearchOptions | undefined {
): Promise<SearchOptions | undefined> {
const searchMetadata = websiteConfigMetadata(kSearch, project.config);

// The location of the search input
const location = searchInputLocation(project);
const location = await searchInputLocation(project);

if (searchMetadata) {
// Sort out collapsing (by default, show 2 sections per document)
Expand Down Expand Up @@ -545,9 +545,9 @@ function algoliaOptions(
}
}

export function searchInputLocation(
export async function searchInputLocation(
project: ProjectContext,
): SearchInputLocation {
): Promise<SearchInputLocation> {
const searchConfig = websiteConfigMetadata(kSearch, project.config);
if (searchConfig && searchConfig[kLocation]) {
switch (searchConfig[kLocation]) {
Expand All @@ -558,7 +558,7 @@ export function searchInputLocation(
return "navbar";
}
} else {
const { navbar } = websiteNavigationConfig(project);
const { navbar } = await websiteNavigationConfig(project);
if (navbar) {
return "navbar";
} else {
Expand All @@ -581,15 +581,15 @@ export function websiteSearchSassBundle() {
};
}

export function websiteSearchIncludeInHeader(
export async function websiteSearchIncludeInHeader(
project: ProjectContext,
format: Format,
temp: TempContext,
) {
// Generates a script tag that contains the options for configuring search
// which is ready in quarto-search.js
const websiteSearchScript = temp.createFile({ suffix: "-search.html" });
const options = searchOptions(project) || {} as SearchOptions;
const options = await searchOptions(project) || {} as SearchOptions;
options[kLanguageDefaults] = {} as FormatLanguage;
Object.keys(format.language).forEach((key) => {
if (key.startsWith("search-")) {
Expand All @@ -615,14 +615,14 @@ export function websiteSearchIncludeInHeader(
return websiteSearchScript;
}

export function websiteSearchDependency(
export async function websiteSearchDependency(
project: ProjectContext,
source: string,
): FormatDependency[] {
): Promise<FormatDependency[]> {
const searchDependencies: FormatDependency[] = [];
const resources: DependencyFile[] = [];

const options = searchOptions(project);
const options = await searchOptions(project);
if (options) {
const sourceRelative = relative(project.dir, source);
const offset = projectOffset(project, source);
Expand Down
31 changes: 30 additions & 1 deletion src/project/types/website/website-shared.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ export function inputFileHref(href: string) {
return pathWithForwardSlashes(htmlHref);
}

export function websiteNavigationConfig(project: ProjectContext) {
export async function websiteNavigationConfig(project: ProjectContext) {
// read navbar
let navbar = websiteConfig(kSiteNavbar, project.config) as
| Navbar
Expand Down Expand Up @@ -164,6 +164,35 @@ export function websiteNavigationConfig(project: ProjectContext) {
}
}

const projectBrand = await project.resolveBrand();
if (
projectBrand?.processedData.logo && sidebars?.[0]
) {
if (sidebars[0].logo === undefined) {
const logo = projectBrand.processedData.logo.medium ??
projectBrand.processedData.logo.small ??
projectBrand.processedData.logo.large;
if (typeof logo === "string") {
sidebars[0].logo = logo;
} else if (typeof logo === "object") {
sidebars[0].logo = logo.light; // TODO: This needs smarts to work on light+dark themes
}
}
}

if (
projectBrand?.processedData && navbar
) {
const logo = projectBrand.processedData.logo.small ??
projectBrand.processedData.logo.medium ??
projectBrand.processedData.logo.large;
if (typeof logo === "string") {
navbar.logo = logo;
} else if (typeof logo === "object") {
navbar.logo = logo.light; // TODO: This needs smarts to work on light+dark themes
}
}

// if there is more than one sidebar then propagate options from the
// first sidebar to the others
if (sidebars && sidebars.length > 1) {
Expand Down
Loading