mirror of https://github.com/quartz-community/breadcrumbs.git synced 2026-07-22 02:50:29 +00:00

No description

Find a file

saberzero1 441c3c474b chore: add quartz plugin manifest to package.json		2026-02-17 17:43:43 +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	chore: update @quartz-community/types to v0.2.1	2026-02-13 22:57:26 +01:00
package.json	chore: add quartz plugin manifest to package.json	2026-02-17 17:43:43 +01:00
README.md	docs: add plugin README	2026-02-14 02:13:05 +01:00
tsconfig.json	Initial commit	2026-02-13 12:20:09 +01:00
tsup.config.ts	feat(plugins): breadcrumbs as community plugin	2026-02-13 13:18:55 +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 github:quartz-community/breadcrumbs

// quartz.layout.ts
import * as Plugin from "./.quartz/plugins";

// Add to your layout
Plugin.Breadcrumbs(); // in the appropriate layout section

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.

See the Quartz documentation for more information.

MIT