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
18 commits 1 branch 0 tags 188 KiB
TypeScript 97.8%
SCSS 2.2%
Find a file
saberzero1 eecd82fc11
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:32 +01:00
.github/workflows Initial commit 2026-02-09 22:59:09 +01:00
src Migrate types to use @quartz-community/types exports 2026-02-13 13:18:19 +01:00
test feat(plugins): backlinks as community plugin 2026-02-09 23:19:39 +01:00
.eslintrc.json Initial commit 2026-02-09 22:59:09 +01:00
.gitignore Initial commit 2026-02-09 22:59:09 +01:00
.prettierrc Initial commit 2026-02-09 22:59:09 +01:00
CHANGELOG.md Initial commit 2026-02-09 22:59:09 +01:00
LICENSE Initial commit 2026-02-09 22:59: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:32 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:11 +01:00
tsconfig.json Migrate types to use @quartz-community/types exports 2026-02-13 13:18:19 +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-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