Quartz's default breadcrumbs plugin.
  • TypeScript 97%
  • SCSS 3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:01:12 +01:00
.changeset chore: version package 2026-11-09 04:00:46 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:26 +01:00
src fix: breadcrumbs follow the file path, so permalinked notes keep their folder trail 2026-11-07 23:54:13 +01:00
test feat(plugins): breadcrumbs as community plugin 2026-02-13 13:18:55 +01:00
types fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +01:00
.eslintrc.json fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:06:45 +02:00
.prettierignore fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +01:00
.prettierrc Initial commit 2026-02-13 12:20:09 +01:00
CHANGELOG.md chore: version package 2026-11-09 04:00:46 +00:00
LICENSE Initial commit 2026-02-13 12:20:09 +01:00
package-lock.json chore: version package 2026-11-09 04:00:46 +00:00
package.json chore: version package 2026-11-09 04:00:46 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:56:17 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json Initial commit 2026-02-13 12:20:09 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:49:06 +01:00
vitest.config.ts Initial commit 2026-02-13 12:20:09 +01:00

@quartz-community/breadcrumbs

Displays breadcrumb navigation showing the page's position in the folder hierarchy.

Installation

npx quartz plugin add @quartz-community/breadcrumbs

It is already included (and enabled) in the default quartz.config.yaml.

Usage

plugins:
  - source: "@quartz-community/breadcrumbs"
    enabled: true
    layout:
      position: beforeBody
      priority: 5
      condition: not-index

For advanced use cases, you can override in TypeScript:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.Breadcrumbs({
  spacerSymbol: "❯",
  rootName: "Home",
  resolveFrontmatterTitle: true,
  showCurrentPage: true,
});

Configuration

Option Type Default Description
spacerSymbol string "❯" The symbol used to separate breadcrumb items.
rootName string "Home" The name of the root item in the breadcrumbs.
resolveFrontmatterTitle boolean true Whether to use the title from frontmatter for breadcrumb items.
showCurrentPage boolean true Whether to show the current page in the breadcrumbs.

Documentation

See the Quartz documentation for more information.

License

MIT