Quartz's default citations plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:01:26 +01:00
.changeset chore: version package 2026-11-08 13:32:41 +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:25 +01:00
src fix: lay out numeric bibliography labels inline (jackyzha0/quartz#2471) 2026-11-07 22:42:27 +01:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:06:49 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 21:35:08 +01:00
CHANGELOG.md chore: version package 2026-11-08 13:32:41 +00:00
LICENSE Initial commit 2026-02-13 21:35:08 +01:00
package-lock.json chore: version package 2026-11-08 13:32:41 +00:00
package.json chore: version package 2026-11-08 13:32:41 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:56:17 +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 Initial commit 2026-02-13 21:35:08 +01:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:27 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/citations

Adds academic citation support using a BibTeX bibliography file and configurable citation styles.

Installation

npx quartz plugin add @quartz-community/citations

It is already in the default quartz.config.yaml (disabled, order: 85); set enabled: true to turn it on.

Usage

plugins:
  - source: "@quartz-community/citations"
    enabled: true
    order: 85
    options:
      bibliographyFile: "./bibliography.bib"
      csl: apa

For advanced use cases, you can override in TypeScript:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.Citations({
  bibliographyFile: "./bibliography.bib",
  csl: "apa",
});

Configuration

Option Type Default Description
bibliographyFile string "./bibliography.bib" The path to the BibTeX bibliography file, relative to the root of your Quartz repository.
suppressBibliography boolean false Whether to suppress the bibliography at the end of the page.
linkCitations boolean false Whether to link citations to the bibliography.
csl string "apa" The CSL style to use for citations. See rehype-citation for options.

Documentation

See the Quartz documentation for more information.

License

MIT