Merge pull request #9741 from quarto-dev/website/sidebar-global

Author: cderv

news/changelog-1.5.md

@@ -61,6 +61,7 @@ All changes included in 1.5:
 - ([#8977](https://github.com/quarto-dev/quarto-cli/issues/8977)): Don't decorate about links within external link icons.
 - ([#8986](https://github.com/quarto-dev/quarto-cli/issues/8986)): Search: only build subfuse index when it's safe to do so.
 - ([#9356](https://github.com/quarto-dev/quarto-cli/issues/9356)): Don't process column classes for figures inside the About divs.
+- ([#9741](https://github.com/quarto-dev/quarto-cli/issues/9741)): Sidebar is correctly shown globally when title is used in the `sidebar` configuration.
 - ([#9781](https://github.com/quarto-dev/quarto-cli/issues/9781)): Correctly hide elements from click event in collapsed margin sidebar.
 
 ## Book

src/project/types/website/website-navigation.ts

@@ -288,6 +288,11 @@ export async function websiteNavigationExtras(
   const href = target?.outputHref || inputFileHref(inputRelative);
   const sidebar = sidebarForHref(href, format);
 
+  // if the sidebar has a title and no id generate the id
+  if (sidebar && sidebar.title && !sidebar.id) {
+    sidebar.id = asHtmlId(sidebar.title);
+  }
+
   // Forward the draft mode, if present
   const draftMode = projectDraftMode(project);
 
@@ -1003,11 +1008,6 @@ async function sidebarsEjsData(project: ProjectContext, sidebars: Sidebar[]) {
 async function sidebarEjsData(project: ProjectContext, sidebar: Sidebar) {
   sidebar = ld.cloneDeep(sidebar);
 
-  // if the sidebar has a title and no id generate the id
-  if (sidebar.title && !sidebar.id) {
-    sidebar.id = asHtmlId(sidebar.title);
-  }
-
   // ensure title and search are present
   sidebar.title = sidebarTitle(sidebar, project) as string | undefined;
   sidebar.logo = resolveLogo(sidebar.logo);

src/project/types/website/website-shared.ts

@@ -342,20 +342,21 @@ export const navigation: Navigation = {
 };
 
 export function sidebarForHref(href: string, format: Format) {
+  const sidebars = ld.cloneDeep(navigation.sidebars) as Sidebar[];
   // if there is a single sidebar then it applies to all hrefs
   // (unless it has an id, in which restrict it)
   if (
-    navigation.sidebars.length === 1 && navigation.sidebars[0].id === undefined
+    sidebars.length === 1 && sidebars[0].id === undefined
   ) {
-    return navigation.sidebars[0];
+    return sidebars[0];
   } else {
-    const explicitSidebar = navigation.sidebars.find((sidebar) => {
+    const explicitSidebar = sidebars.find((sidebar) => {
       return sidebar.id === format.metadata[kSiteSidebar];
     });
     if (explicitSidebar) {
       return explicitSidebar;
     } else {
-      const containingSidebar = navigation.sidebars.find((sidebar) => {
+      const containingSidebar = sidebars.find((sidebar) => {
         return containsHref(href, sidebar.contents);
       });
       if (containingSidebar) {

tests/docs/smoke-all/website/sidebar/sidebar-title-external-links/.gitignore

@@ -0,0 +1,2 @@
+/.quarto/
+_site

tests/docs/smoke-all/website/sidebar/sidebar-title-external-links/_quarto.yml

@@ -0,0 +1,22 @@
+project:
+  type: website
+
+website:
+  title: "Test"
+  page-navigation: true
+
+  navbar:
+    left:
+      - text: "External working"
+        href: "https://quarto.org"
+        target: "_blank"
+
+  sidebar:
+    - title: "Dropdown"
+      contents:
+        - text: "External working"
+          href: "https://quarto.org"
+          target: "_blank"
+
+format:
+  html: default

tests/docs/smoke-all/website/sidebar/sidebar-title-external-links/about.qmd

@@ -0,0 +1,13 @@
+---
+title: "About page"
+_quarto:
+  tests: 
+    html:
+      ensureHtmlElements:
+        - 
+          - 'nav.navbar li.nav-item a.nav-link span.menu-text'
+          - 'nav#quarto-sidebar li.sidebar-item a[href*="quarto.org"].sidebar-link'
+        - []
+---
+
+This is an about page that should also have a sidebar

tests/docs/smoke-all/website/sidebar/sidebar-title-external-links/index.qmd

@@ -0,0 +1,14 @@
+---
+title: "Sidebar-title"
+_quarto:
+  tests: 
+    html:
+      ensureHtmlElements:
+        - 
+          - 'nav.navbar li.nav-item a.nav-link span.menu-text'
+          - 'nav#quarto-sidebar li.sidebar-item a[href*="quarto.org"].sidebar-link'
+        - []
+
+---
+
+This test is based on issue https://github.com/quarto-dev/quarto-cli/issues/9242

tests/docs/smoke-all/website/sidebar/sidebar-title-no-navbar/.gitignore

@@ -0,0 +1,2 @@
+/.quarto/
+_site

tests/docs/smoke-all/website/sidebar/sidebar-title-no-navbar/_quarto.yml

@@ -0,0 +1,17 @@
+project:
+  type: website
+
+website:
+  title: "Test"
+  page-navigation: true
+
+  sidebar:
+    - title: "Dropdown"
+      contents:
+        - text: "External working"
+          href: "https://quarto.org"
+          target: "_blank"
+        - index.qmd
+
+format:
+  html: default

tests/docs/smoke-all/website/sidebar/sidebar-title-no-navbar/index.qmd

@@ -0,0 +1,17 @@
+---
+title: "Sidebar-title"
+_quarto:
+  tests: 
+    html:
+      ensureHtmlElements:
+        - 
+          - 'nav#quarto-sidebar div.sidebar-title'
+          - 'nav#quarto-sidebar li.sidebar-item a[href*="quarto.org"].sidebar-link'
+          - 'nav#quarto-sidebar li.sidebar-item a.sidebar-link span.menu-text' 
+        - []
+
+---
+
+This is a Quarto website.
+
+To learn more about Quarto websites visit <https://quarto.org/docs/websites>.