/

Quarkdown

1.13.0

Docs

On this page

Bibliography

Quarkdown provides first-class bibliography generation with out-of-the-box BibTeX compatibility.

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

Example 1

.bibliography {bibliography/file.bib}

References

[1]Albert Einstein. Zur Elektrodynamik bewegter Körper. (German) [On the electrodynamics of moving bodies]. Annalen der Physik, 322(10):891–921, 1905.[2]Stephen Hawking. A Brief History of Time. Bantam Books, 1988.[3]Michel Goossens, Frank Mittelbach, and Alexander Samarin. The LaTeX Companion. Addison-Wesley, Reading, Massachusetts, 1993.

Citations

You can cite an entry from the bibliography using the .cite {key} function.

Consider the following BibTeX entry:

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

You can cite it using the einstein key.

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.

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.

Style

The optional style parameter configures the look and format of the bibliography and its citation references. Styles are directly inspired by LaTeX, and you can find comprehensive comparisons here.

The currently supported styles are:

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

[1]Albert Einstein. Zur Elektrodynamik bewegter Körper. (German) [On the electrodynamics of moving bodies]. Annalen der Physik, 322(10):891–921, 1905.[2]Stephen Hawking. A Brief History of Time. Bantam Books, 1988.[3]Michel Goossens, Frank Mittelbach, and Alexander Samarin. The LaTeX Companion. Addison-Wesley, Reading, Massachusetts, 1993.

Depending on the current auto page break configuration, the title may cause a page break. You can prevent page breaks by turning the title into a decorative heading using the decorativetitle parameter:

.bibliography {file.bib} title:{My bibliography} decorativetitle:{yes}