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
16 commits 1 branch 0 tags 178 KiB
TypeScript 96.8%
SCSS 3.2%
Find a file
saberzero1 a188cf8182
chore: move build tools to devDependencies, shared deps to peerDependencies 
tsup and typescript are only needed at build time — move to devDependencies
so they can be pruned after build. Dependencies already available from the
host Quartz installation are moved to peerDependencies to avoid duplication.
2026-03-14 21:26:35 +01:00
.github/workflows Initial commit 2026-02-13 12:20:09 +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 feat(plugins): breadcrumbs as community plugin 2026-02-13 13:18:55 +01:00
.eslintrc.json Initial commit 2026-02-13 12:20:09 +01:00
.gitignore Initial commit 2026-02-13 12:20:09 +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 deps: update @quartz-community/types and @quartz-community/utils 2026-03-09 03:03:56 +01:00
package.json chore: move build tools to devDependencies, shared deps to peerDependencies 2026-03-14 21:26:35 +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 fix: compile SCSS via sass instead of raw text to prevent lightningcss errors 2026-02-26 16:44:50 +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