mirror of
https://gitlab.com/MisterBiggs/brain-quartz.git
synced 2025-07-26 16:21:26 +00:00
.github
content
docs
advanced
features
images
plugins
AliasRedirects.md
Assets.md
CNAME.md
Citations.md
ComponentResources.md
ContentIndex.md
ContentPage.md
CrawlLinks.md
CreatedModifiedDate.md
CustomOgImages.md
Description.md
ExplicitPublish.md
Favicon.md
FolderPage.md
Frontmatter.md
GitHubFlavoredMarkdown.md
HardLineBreaks.md
Latex.md
NotFoundPage.md
ObsidianFlavoredMarkdown.md
OxHugoFlavoredMarkdown.md
RemoveDrafts.md
RoamFlavoredMarkdown.md
Static.md
SyntaxHighlighting.md
TableOfContents.md
TagPage.md
index.md
tags
authoring content.md
build.md
configuration.md
hosting.md
index.md
layout-components.md
layout.md
migrating from Quartz 3.md
philosophy.md
setting up your GitHub repository.md
showcase.md
upgrading.md
quartz
.gitattributes
.gitignore
.gitlab-ci.yml
.gitmodules
.node-version
.npmrc
.prettierignore
.prettierrc
CODE_OF_CONDUCT.md
Dockerfile
LICENSE.txt
README.md
bun.lock
globals.d.ts
index.d.ts
package-lock.json
package.json
quartz.config.ts
quartz.layout.ts
tsconfig.json
* docs: add Citation plugin & feature pages Discussed and extracted from #1557 * Update docs/features/Citations.md * Apply suggestions from code review --------- Co-authored-by: Aaron Pham <Aaronpham0103@gmail.com>
25 lines
1.0 KiB
Markdown
25 lines
1.0 KiB
Markdown
---
|
|
title: "Citations"
|
|
tags:
|
|
- plugin/transformer
|
|
---
|
|
|
|
This plugin adds Citation support to Quartz.
|
|
|
|
> [!note]
|
|
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
|
|
|
|
This plugin accepts the following configuration options:
|
|
|
|
- `bibliographyFile`: the path to the bibliography file. Defaults to `./bibliography.bib`. This is relative to git source of your vault.
|
|
- `suppressBibliography`: whether to suppress the bibliography at the end of the document. Defaults to `false`.
|
|
- `linkCitations`: whether to link citations to the bibliography. Defaults to `false`.
|
|
- `csl`: the citation style to use. Defaults to `apa`. Reference [rehype-citation](https://rehype-citation.netlify.app/custom-csl) for more options.
|
|
- `prettyLink`: whether to use pretty links for citations. Defaults to `true`.
|
|
|
|
## API
|
|
|
|
- Category: Transformer
|
|
- Function name: `Plugin.Citations()`.
|
|
- Source: [`quartz/plugins/transformers/citations.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/citations.ts).
|