mirror of https://github.com/quartz-community/citations.git synced 2026-07-22 02:50:26 +00:00

No description

Find a file

saberzero1 2ad133a123 chore: regenerate package-lock.json		2026-05-24 17:32:43 +02:00
.github/workflows	build: bundle dependencies and ship pre-built dist	2026-04-27 21:37:27 +02:00
dist	fix: add createRequire banner for CJS compat in ESM bundles	2026-03-17 20:34:33 +01:00
src	feat: extract citations transformer from Quartz core	2026-02-13 22:31:03 +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: commit dist/ and remove prepare script	2026-03-14 21:57:21 +01: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	Initial commit	2026-02-13 21:35:08 +01:00
LICENSE	Initial commit	2026-02-13 21:35:08 +01:00
package-lock.json	chore: regenerate package-lock.json	2026-05-24 17:32:43 +02:00
package.json	chore: remove vestigial @jackyzha0/quartz peerDependency	2026-05-24 16:23:39 +02:00
README.md	docs: update README for v5 unified config system	2026-02-25 16:07:03 +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 github:quartz-community/citations

plugins:
  - source: github:quartz-community/citations
    enabled: true
    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",
});

Option	Type	Default	Description
`bibliographyFile`	`string`	`"./bibliography.bib"`	The path to the BibTeX bibliography file.
`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 the Quartz documentation for more information.

MIT