Quartz's default backlinks plugin.
  • TypeScript 97.8%
  • SCSS 2.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:00:58 +01:00
.changeset chore: version package 2026-11-09 04:00:31 +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 feat: exclude unlisted pages from backlink sources 2026-04-11 13:49:59 +02:00
test feat: exclude unlisted pages from backlink sources 2026-04-11 13:49:59 +02: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:42 +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-09 22:59:09 +01:00
CHANGELOG.md chore: version package 2026-11-09 04:00:31 +00:00
LICENSE Initial commit 2026-02-09 22:59:09 +01:00
package-lock.json chore: version package 2026-11-09 04:00:31 +00:00
package.json chore: version package 2026-11-09 04:00:31 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:56:16 +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 fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +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-09 22:59:09 +01:00

@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