quartz/docs/plugins/Breadcrumbs.md at cce45e07188e393c11104dc12aefe0486b183433 - quartz - zainezq

zaine/quartz

Files

saberzero1 cce45e0718 docs: add repository, enabled, required frontmatter to all plugin docs

Added repository, enabled, and required fields to the frontmatter of
all 44 plugin documentation files. Updated Plugins.base to include
these columns, matching the information previously in the manual tables.
Also filtered out internal plugins (Assets, Static, ComponentResources,
NotFoundPage) from the base query.

2026-05-24 19:46:42 +02:00

1.2 KiB

Raw Blame History

title, tags, image, repository, enabled, required

title

tags

image

repository

enabled

required

Breadcrumbs

plugin/component

quartz-community/breadcrumbs

true

false

Navigation breadcrumb trail.

Note

For information on how to add, remove or configure plugins, see the configuration#Plugins page.

See plugins/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