quartz-community/backlinks
1
0
Fork 0
mirror of https://github.com/quartz-community/backlinks.git synced 2026-07-22 02:50:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
55 commits 1 branch 0 tags 188 KiB
TypeScript 97.8%
SCSS 2.2%
Find a file
saberzero1 7490f921b7
chore(deps): update @quartz-community/utils
2026-06-03 15:24:50 +02:00
.github/workflows build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:19 +02:00
dist chore(deps): update @quartz-community/utils 2026-06-03 15:24:50 +02: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: commit dist/ and remove prepare script 2026-03-14 21:56:19 +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-09 22:59:09 +01:00
CHANGELOG.md feat: exclude unlisted pages from backlink sources 2026-04-11 13:49:59 +02:00
LICENSE Initial commit 2026-02-09 22:59:09 +01:00
package-lock.json chore(deps): update @quartz-community/utils 2026-06-03 15:24:50 +02:00
package.json chore: remove vestigial @jackyzha0/quartz peerDependency 2026-05-24 16:23:36 +02:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:11 +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: bundle dependencies and ship pre-built dist 2026-04-27 21:37:19 +02:00
vitest.config.ts Initial commit 2026-02-09 22:59:09 +01:00

README.md

@quartz-community/backlinks

Displays a list of pages that link back to the current page.

Installation

npx quartz plugin add github:quartz-community/backlinks

Usage

plugins:
  - source: github:quartz-community/backlinks
    enabled: true
    layout:
      position: right
      priority: 30

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