GitHub/quartz
1
0
Fork 2
mirror of https://github.com/jackyzha0/quartz.git synced 2026-03-21 21:45:42 -05:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
v5
quartz/docs/plugins/Breadcrumbs.md
saberzero1 627fa78f19
docs: updated Bases documentation
2026-03-19 22:18:42 +01:00

1.2 KiB
Raw Permalink Blame History

title tags image
Breadcrumbs
plugin/component

Navigation breadcrumb trail.

Note

For information on how to add, remove or configure plugins, see the configuration#Plugins 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

- 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
  • Install: npx quartz plugin add github:quartz-community/breadcrumbs