mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-22 05:55:42 -05:00
42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
---
|
||
title: Breadcrumbs
|
||
tags:
|
||
- plugin/component
|
||
image:
|
||
---
|
||
|
||
Navigation breadcrumb trail.
|
||
|
||
> [!note]
|
||
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
|
||
|
||
See [[breadcrumbs]] for detailed usage information.
|
||
|
||
## Configuration
|
||
|
||
This plugin accepts the following configuration options:
|
||
|
||
- `spacerSymbol`: The symbol to use between breadcrumb items. Defaults to `"❯"`.
|
||
- `rootName`: The name of the root page. Defaults to `Home`.
|
||
- `resolveFrontmatterTitle`: Whether to use the `title` frontmatter field for breadcrumb items. Defaults to `true`.
|
||
- `showCurrentPage`: Whether to show the current page in the breadcrumb trail. Defaults to `true`.
|
||
|
||
### Default options
|
||
|
||
```yaml title="quartz.config.yaml"
|
||
- source: github:quartz-community/breadcrumbs
|
||
enabled: true
|
||
options:
|
||
spacerSymbol: "❯"
|
||
rootName: Home
|
||
resolveFrontmatterTitle: true
|
||
showCurrentPage: true
|
||
```
|
||
|
||
## API
|
||
|
||
- Category: Component
|
||
- Function name: `ExternalPlugin.Breadcrumbs()`.
|
||
- Source: [`quartz-community/breadcrumbs`](https://github.com/quartz-community/breadcrumbs)
|
||
- Install: `npx quartz plugin add github:quartz-community/breadcrumbs`
|