Breadcrumbs

summary:

• Renders parent-folder navigation trail.
• Default position: beforeBody

Note

Configuration: plugin management.

Customization

yaml_config:

• file: quartz.config.yaml
• key: options

quartz.config.yaml

plugins:
  - source: github:quartz-community/breadcrumbs
    enabled: true
    options:
      spacerSymbol: "❯"
      rootName: Home
      resolveFrontmatterTitle: true
      showCurrentPage: true
    layout:
      position: beforeBody
      priority: 5

typescript_config:

• file: quartz.ts
• placement: before loadQuartzConfig()

quartz.ts (override)

// Place before loadQuartzConfig()
ExternalPlugin.Breadcrumbs({
  spacerSymbol: "❯",
  rootName: "Home",
  resolveFrontmatterTitle: true,
  showCurrentPage: true,
})

reference:

• options: optional; omitted fields use defaults
• position: set layout.position; see layout
• disable: remove the quartz.config.yaml entry or set enabled: false
• install: npx quartz plugin add github:quartz-community/breadcrumbs
• source: quartz-community/breadcrumbs