mirror of
https://github.com/quartz-community/backlinks.git
synced 2026-11-17 00:03:29 +00:00
Quartz's default backlinks plugin.
- TypeScript 97.8%
- SCSS 2.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .changeset | ||
| .github/workflows | ||
| src | ||
| test | ||
| types | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| vitest.config.ts | ||
@quartz-community/backlinks
Displays a list of pages that link back to the current page. Backlinks come from the links Quartz collects while building (the built-in link processing, configuration.links); unlisted pages are left out.
Installation
npx quartz plugin add @quartz-community/backlinks
It is already included (and enabled) in the default quartz.config.yaml.
Usage
plugins:
- source: "@quartz-community/backlinks"
enabled: true
layout:
position: right
priority: 50
For advanced use cases, you can override in TypeScript:
import * as ExternalPlugin from "./.quartz/plugins";
ExternalPlugin.Backlinks({
hideWhenEmpty: true,
});
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
hideWhenEmpty |
boolean |
true |
Whether to hide the backlinks section when no pages link back to the current page. |
Documentation
See the Quartz documentation for more information.
License
MIT