Bibliography

Quarkdown provides CSL-powered bibliography support for the following bibliography formats:

BibTeX (.bib)
CSL JSON (.json)
YAML (.yaml/.yml)
EndNote (.enl)
RIS (.ris)

To get started, call the .bibliography {file} ^{docs ↗} function, where file is the path to your bibliography file, with extension. You can find some BibTeX examples here.

Example 1

.bibliography {bibliography/file.bib}

References

[1]A. Einstein, “Zur Elektrodynamik bewegter Körper. (German) [On the electrodynamics of moving bodies],” Annalen der Physik, vol. 322, Art. no. 10, 1905, doi: http://dx.doi.org/10.1002/andp.19053221004.[2]S. Hawking, A Brief History of Time. Bantam Books, 1988.[3]M. Goossens, F. Mittelbach, and A. Samarin, The LaTeX Companion. Reading, Massachusetts: Addison-Wesley, 1993.

Citations

You can cite one or more entries from the bibliography using the .cite {key} function.

Consider the following BibTeX entries:

@article{einstein,
  author = "Albert Einstein",
  ...
}

@book{hawking,
  author = "Stephen Hawking",
  ...
}

You can cite them using their keys. Multiple keys can be specified as a comma-separated list to produce a single combined citation label, whose format depends on the active citation style.

Example 2

Einstein's publication .cite {einstein} in 1905 revolutionized the field of physics.
Similarly, Hawking's book .cite {hawking} has had a profound impact
on our understanding of cosmology and black holes.

These works .cite {einstein, hawking} are foundational to modern physics.

Einstein’s publication [1] in 1905 revolutionized the field of physics. Similarly, Hawking’s book [2] has had a profound impact on our understanding of cosmology and black holes.

These works [1], [2] are foundational to modern physics.

Style

The optional style parameter configures the look and format of the bibliography and its citation references. It accepts a CSL (Citation Style Language) style identifier. Quarkdown ships with a selection of citation styles from the CSL Style Repository, including ieee (default), apa, chicago-author-date, nature, modern-language-association, and many more.

.bibliography {bibliography.bib} style:{apa}

The full list of supported styles is available in the style catalog.

Title

By default, the title is localized to the current locale set via .doclang, if supported. You can set a custom title using the title parameter.

Example 3

.bibliography {bibliography/file.bib} title:{My bibliography}

My bibliography

Heading options

The heading that precedes the bibliography can be further customized with the following parameters:

Parameter	Description	Accepts	Default
`headingdepth`	Depth of the heading that precedes the bibliography.	Integer	`1`
`breakpage`	Whether the heading triggers an automatic page break.	Boolean	`yes`
`numberheading`	Whether the heading should be numbered and have its position tracked in the document hierarchy.	Boolean	`no`
`indexheading`	Whether the heading should be included in the document’s table of contents. Implicitly enables `numberheading`.	Boolean	`no`

For example, depending on the current auto page break configuration, the title may cause a page break. You can prevent this:

.bibliography {file.bib} title:{My bibliography} breakpage:{no}