bibliographyElement
A bibliography / reference listing.
You can create a new bibliography by calling this function with a path to a bibliography file in either one of two formats:
- A Hayagriva
.yaml/.ymlfile. Hayagriva is a new bibliography file format designed for use with Typst. Visit its documentation for more details. - A BibLaTeX
.bibfile.
As soon as you add a bibliography somewhere in your document, you can start
citing things with reference syntax (@key) or explicit calls to the
citation function (#cite(<key>)). The bibliography will only
show entries for works that were referenced in the document.
Styles
Typst offers a wide selection of built-in citation and bibliography styles. Beyond those, you can add and use custom CSL (Citation Style Language) files. Wondering which style to use? Here are some good defaults based on what discipline you're working in:
| Fields | Typical Styles |
|---|---|
| Engineering, IT | "ieee" |
| Psychology, Life Sciences | "apa" |
| Social sciences | "chicago-author-date" |
| Humanities | "mla", "chicago-notes", "harvard-cite-them-right" |
| Economics | "harvard-cite-them-right" |
| Physics | "american-physics-society" |
Example
This was already noted by
pirates long ago. @arrgh
Multiple sources say ...
@arrgh @netwok.
#bibliography("works.bib")
Parameters
sources
One or multiple paths to or raw bytes for Hayagriva .yaml and/or
BibLaTeX .bib files.
This can be a:
- A path string to load a bibliography file from the given path. For more details about paths, see the Paths section.
- Raw bytes from which the bibliography should be decoded.
- An array where each item is one of the above.
title
The title of the bibliography.
- When set to
auto, an appropriate title for the text language will be used. This is the default. - When set to
none, the bibliography will not have a title. - A custom title can be set by passing content.
The bibliography's heading will not be numbered by default, but you can
force it to be with a show-set rule:
show bibliography: set heading(numbering: "1.")
Default: auto
full
Whether to include all works from the given bibliography files, even those that weren't cited in the document.
To selectively add individual cited works without showing them, you can
also use the cite function with form set to none.
Default: false
style
The bibliography style.
This can be:
- A string with the name of one of the built-in styles (see below). Some of the styles listed below appear twice, once with their full name and once with a short alias.
- A path string to a CSL file. For more details about paths, see the Paths section.
- Raw bytes from which a CSL style should be decoded.
View options
| Variant | Details |
|---|---|
"alphanumeric" | Alphanumeric |
"american-anthropological-association" | American Anthropological Association |
"american-chemical-society" | American Chemical Society |
"american-geophysical-union" | American Geophysical Union |
"american-institute-of-aeronautics-and-astronautics" | American Institute of Aeronautics and Astronautics |
"american-institute-of-physics" | American Institute of Physics 4th edition |
"american-medical-association" | American Medical Association 11th edition |
"american-meteorological-society" | American Meteorological Society |
"american-physics-society" | American Physical Society |
"american-physiological-society" | American Physiological Society |
"american-political-science-association" | American Political Science Association |
"american-psychological-association" | American Psychological Association 7th edition |
"apa" | A short alias of |
"american-society-for-microbiology" | American Society for Microbiology |
"american-society-of-civil-engineers" | American Society of Civil Engineers |
"american-society-of-mechanical-engineers" | American Society of Mechanical Engineers |
"american-sociological-association" | American Sociological Association 6th/7th edition |
"angewandte-chemie" | Angewandte Chemie International Edition |
"annual-reviews" | Annual Reviews (sorted by order of appearance) |
"annual-reviews-author-date" | Annual Reviews (author-date) |
"associacao-brasileira-de-normas-tecnicas" | Associação Brasileira de Normas Técnicas (Português - Brasil) |
"association-for-computing-machinery" | Association for Computing Machinery |
"biomed-central" | BioMed Central |
"bristol-university-press" | Bristol University Press |
"british-medical-journal" | BMJ |
"bmj" | A short alias of |
"cell" | Cell |
"chicago-author-date" | Chicago Manual of Style 18th edition (author-date) |
"chicago-notes" | Chicago Manual of Style 18th edition (notes and bibliography) |
"chicago-fullnotes" | A short alias of |
"chicago-shortened-notes" | Chicago Manual of Style 18th edition (shortened notes and bibliography) |
"copernicus" | Copernicus Publications |
"council-of-science-editors" | Council of Science Editors, Citation-Sequence (numeric, brackets) |
"council-of-science-editors-author-date" | Council of Science Editors, Name-Year 9th edition (author-date) |
"current-opinion" | Current Opinion journals |
"deutsche-gesellschaft-für-psychologie" | Deutsche Gesellschaft für Psychologie 5. Auflage (Deutsch) |
"deutsche-sprache" | Deutsche Sprache (Deutsch) |
"elsevier-harvard" | Elsevier - Harvard (with titles) |
"elsevier-vancouver" | Elsevier - Vancouver |
"elsevier-with-titles" | Elsevier (numeric, with titles) |
"frontiers" | Frontiers journals |
"future-medicine" | Future Medicine journals |
"future-science" | Future Science Group |
"gb-7714-2005-numeric" | China National Standard GB/T 7714-2005 (numeric, 中文) |
"gb-7714-2015-author-date" | China National Standard GB/T 7714-2015 (author-date, 中文) |
"gb-7714-2015-note" | China National Standard GB/T 7714-2015 (note, 中文) |
"gb-7714-2015-numeric" | China National Standard GB/T 7714-2015 (numeric, 中文) |
"gost-r-705-2008-numeric" | Russian GOST R 7.0.5-2008 (numeric) |
"harvard-cite-them-right" | Cite Them Right 12th edition - Harvard |
"institute-of-electrical-and-electronics-engineers" | IEEE |
"ieee" | A short alias of |
"institute-of-physics-numeric" | Institute of Physics (numeric) |
"iso-690-author-date" | ISO-690 (author-date, English) |
"iso-690-numeric" | ISO-690 (numeric, English) |
"karger" | Karger journals |
"mary-ann-liebert-vancouver" | Mary Ann Liebert - Vancouver |
"modern-humanities-research-association-notes" | Modern Humanities Research Association 4th edition (notes) |
"modern-humanities-research-association" | A short alias of |
"modern-language-association" | Modern Language Association 9th edition (in-text citations) |
"mla" | A short alias of |
"modern-language-association-8" | Modern Language Association 8th edition |
"mla-8" | A short alias of |
"multidisciplinary-digital-publishing-institute" | Multidisciplinary Digital Publishing Institute |
"nature" | Nature |
"pensoft" | Pensoft Journals |
"public-library-of-science" | Public Library of Science |
"plos" | A short alias of |
"royal-society-of-chemistry" | Royal Society of Chemistry |
"sage-vancouver" | SAGE - Vancouver |
"sist02" | SIST02 (日本語) |
"spie" | SPIE journals |
"springer-basic" | Springer - Basic (numeric, brackets) |
"springer-basic-author-date" | Springer - Basic (author-date) |
"springer-fachzeitschriften-medizin-psychologie" | Springer - Fachzeitschriften Medizin Psychologie (Deutsch) |
"springer-humanities-author-date" | Springer - Humanities (author-date) |
"springer-lecture-notes-in-computer-science" | Springer - Lecture Notes in Computer Science |
"springer-mathphys" | Springer - MathPhys (numeric, brackets) |
"springer-socpsych-author-date" | Springer - SocPsych (author-date) |
"springer-vancouver" | Springer - Vancouver (brackets) |
"taylor-and-francis-chicago-author-date" | Taylor & Francis Journals Standard Reference Style Guide: Chicago author-date version 2.0 |
"taylor-and-francis-national-library-of-medicine" | Taylor & Francis - National Library of Medicine |
"the-institution-of-engineering-and-technology" | The Institution of Engineering and Technology |
"the-lancet" | The Lancet |
"thieme" | Thieme-German (Deutsch) |
"trends" | Trends journals |
"turabian-author-date" | Chicago Manual of Style 17th edition (author-date) |
"turabian-fullnote-8" | Chicago Manual of Style 17th edition (notes and bibliography, subsequent author-title) |
"vancouver" | Vancouver |
"vancouver-superscript" | Vancouver (superscript) |
Default: "ieee"