mirror of
https://github.com/quartz-community/citations.git
synced 2026-11-16 23:53:34 +00:00
Quartz's default citations plugin.
- TypeScript 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .changeset | ||
| .github/workflows | ||
| src | ||
| types | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| vitest.config.ts | ||
@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