quartz-community/breadcrumbs
1
0
Fork 0
mirror of https://github.com/quartz-community/breadcrumbs.git synced 2026-07-22 02:50:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
21 commits 1 branch 0 tags 178 KiB
TypeScript 96.8%
SCSS 3.2%
Find a file
saberzero1 fe32923b12
chore: set tsup platform to node 
Plugins run server-side during the Quartz build step, not in the
browser. Setting platform: 'node' tells esbuild to treat Node builtins
as available externals and avoids CJS-in-ESM require() failures for
any bundled dependencies that use Node APIs.
2026-03-17 20:41:14 +01:00
.github/workflows ci: add dist externals verification step 2026-03-17 19:41:47 +01:00
dist chore: commit dist/ and remove prepare script 2026-03-14 21:57:12 +01:00
src feat(plugins): breadcrumbs as community plugin 2026-02-13 13:18:55 +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: commit dist/ and remove prepare script 2026-03-14 21:57:12 +01: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 Initial commit 2026-02-13 12:20:09 +01:00
LICENSE Initial commit 2026-02-13 12:20:09 +01:00
package-lock.json fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +01:00
package.json fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:11 +01:00
tsconfig.json Initial commit 2026-02-13 12:20:09 +01:00
tsup.config.ts chore: set tsup platform to node 2026-03-17 20:41:14 +01:00
vitest.config.ts Initial commit 2026-02-13 12:20:09 +01:00

README.md

@quartz-community/breadcrumbs

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

Installation

npx quartz plugin add github:quartz-community/breadcrumbs

Usage

plugins:
  - source: github: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