Use the breadcrumbs option to control the links displayed at the top of the page to indicate a page's location in the navigation structure.
The breadcrumbs option also supports page-level configuration using front matter.
Breadcrumbs are enabled by default, but can be disabled to remove them from your published project. You can also add links that you want to always appear on every page at the start of the breadcrumbs links.
| Option | Type | Description |
|---|---|---|
| hide | boolean | Disables breadcrumb links in the project when set to true.Default value: false |
| prefixItems | [Breadcrumb object] | A list of breadcrumb links to always be displayed first. |
| Option | Type | Description |
|---|---|---|
| page | string | REQUIRED. Path to the file which represents the page to link to. If you do not include the label property, the text for the link will match the level 1 heading of the page. |
| label | string | Link text displayed for the item. |
| labelTranslationKey | string | Translation key used for localization. |
breadcrumbs:
hide: false
prefixItems:
- page: index.page.tsx
label: Home
labelTranslationKey: home.title- Customize other default items on Markdown pages, such as the last updated time stamp and the page headings table of contents on the left side of the page, using the
markdownconfiguration options. - Remove or update the label text for the previous and next navigation buttons using the
navigationconfiguration options.
- Navigation concepts - Understand different navigation elements in your project including breadcrumbs and their role in user experience
- Configure navigation elements - Customize navigation elements including sidebar, navbar, footer, and breadcrumbs for optimal site organization
- Front matter configuration - Configure breadcrumb behavior and appearance on individual pages using front matter for granular control
- Configuration options - Explore other project configuration options for comprehensive documentation and platform customization