Skip to content

Commit

Permalink
Merge pull request #1538 from quarto-dev/sync-1329-to-prerelease
Browse files Browse the repository at this point in the history
  • Loading branch information
cderv authored Jan 14, 2025
2 parents 1c1a3c5 + 392e17d commit 370bb9a
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/websites/website-navigation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,14 @@ Here are all of the options available for side navigation:
| `collapse-level` | Whether to show sidebar navigation collapsed by default. The default is 2, which shows the top and next level fully expanded (but leaves the 3rd and subsequent levels collapsed). |
| `pinned` | Always show a title bar that expands to show the sidebar at narrower screen widths (true or false). Defaults to false, and uses [headroom.js](https://wicky.nillia.ms/headroom.js/) to automatically show the navigation bar when the user scrolls up on the page. |

A single `sidebar` item without an `id` or `title` will result in a global sidebar applied to all pages. A sidebar with an `id` or `title` will only be applied to pages within the contents of the sidebar or pages that specify the sidebar id.
A single `sidebar` item without an `id` or `title` will result in a global sidebar applied to all pages. A sidebar with an `id` or `title` will only be applied to pages within the contents of the sidebar or pages that specify the sidebar id.

To use a specific sidebar on a page or a group of pages, specify the `sidebar` ID in the front matter of the page or in the `_metadata.yml` file.
For example, to include the tutorials sidebar on a page, add the following to the page's front matter:

```yaml
sidebar: <id>
```

For more information on controlling the appearance of the side navigation using HTML themes, see [HTML Themes - Navigation](/docs/output-formats/html-themes.qmd#navigation). If you need to control the width of the sidebar, see [Page Layout - Grid Customization](/docs/output-formats/page-layout.qmd#grid-customization).

Expand Down Expand Up @@ -376,7 +383,6 @@ website:
title: "Reference"
contents:
# navigation items
```

## Breadcrumbs
Expand Down

0 comments on commit 370bb9a

Please sign in to comment.