bibliographyElementElementElement functions can be customized with set and show rules.
set and show rules.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")
ParameterParameterParameters are input values for functions. Specify them in parentheses after the function name.
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 value: auto
fullSettableSettableSettable parameters can be set using the set rule, changing the default value used thereafter.
set rule, changing the default value used thereafter.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 value: 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.
Available string values:
alphanumericAlphanumeric
american-anthropological-associationAmerican Anthropological Association
american-chemical-societyAmerican Chemical Society
american-geophysical-unionAmerican Geophysical Union
american-institute-of-aeronautics-and-astronauticsAmerican Institute of Aeronautics and Astronautics
american-institute-of-physicsAmerican Institute of Physics 4th edition
american-medical-associationAmerican Medical Association 11th edition
american-meteorological-societyAmerican Meteorological Society
american-physics-societyAmerican Physical Society
american-physiological-societyAmerican Physiological Society
american-political-science-associationAmerican Political Science Association
american-psychological-associationAmerican Psychological Association 7th edition
apaA short alias of
american-psychological-associationamerican-society-for-microbiologyAmerican Society for Microbiology
american-society-of-civil-engineersAmerican Society of Civil Engineers
american-society-of-mechanical-engineersAmerican Society of Mechanical Engineers
american-sociological-associationAmerican Sociological Association 6th/7th edition
angewandte-chemieAngewandte Chemie International Edition
annual-reviewsAnnual Reviews (sorted by order of appearance)
annual-reviews-author-dateAnnual Reviews (author-date)
associacao-brasileira-de-normas-tecnicasAssociação Brasileira de Normas Técnicas (Português - Brasil)
association-for-computing-machineryAssociation for Computing Machinery
biomed-centralBioMed Central
bristol-university-pressBristol University Press
british-medical-journalBMJ
bmjA short alias of
british-medical-journalcellCell
chicago-author-dateChicago Manual of Style 17th edition (author-date)
chicago-fullnotesChicago Manual of Style 17th edition (full note)
chicago-notesChicago Manual of Style 17th edition (note)
copernicusCopernicus Publications
council-of-science-editorsCouncil of Science Editors, Citation-Sequence (numeric, brackets)
council-of-science-editors-author-dateCouncil of Science Editors, Name-Year (author-date)
current-opinionCurrent Opinion journals
deutsche-gesellschaft-für-psychologieDeutsche Gesellschaft für Psychologie 5. Auflage (Deutsch)
deutsche-spracheDeutsche Sprache (Deutsch)
elsevier-harvardElsevier - Harvard (with titles)
elsevier-vancouverElsevier - Vancouver
elsevier-with-titlesElsevier (numeric, with titles)
frontiersFrontiers journals
future-medicineFuture Medicine journals
future-scienceFuture Science Group
gb-7714-2005-numericChina National Standard GB/T 7714-2005 (numeric, 中文)
gb-7714-2015-author-dateChina National Standard GB/T 7714-2015 (author-date, 中文)
gb-7714-2015-noteChina National Standard GB/T 7714-2015 (note, 中文)
gb-7714-2015-numericChina National Standard GB/T 7714-2015 (numeric, 中文)
gost-r-705-2008-numericRussian GOST R 7.0.5-2008 (numeric)
harvard-cite-them-rightCite Them Right 12th edition - Harvard
institute-of-electrical-and-electronics-engineersIEEE
ieeeA short alias of
institute-of-electrical-and-electronics-engineersinstitute-of-physics-numericInstitute of Physics (numeric)
iso-690-author-dateISO-690 (author-date, English)
iso-690-numericISO-690 (numeric, English)
kargerKarger journals
mary-ann-liebert-vancouverMary Ann Liebert - Vancouver
modern-humanities-research-associationModern Humanities Research Association 4th edition (note with bibliography)
modern-language-associationModern Language Association 9th edition
mlaA short alias of
modern-language-associationmodern-language-association-8Modern Language Association 8th edition
mla-8A short alias of
modern-language-association-8multidisciplinary-digital-publishing-instituteMultidisciplinary Digital Publishing Institute
natureNature
pensoftPensoft Journals
public-library-of-sciencePublic Library of Science
plosA short alias of
public-library-of-scienceroyal-society-of-chemistryRoyal Society of Chemistry
sage-vancouverSAGE - Vancouver
sist02SIST02 (日本語)
spieSPIE journals
springer-basicSpringer - Basic (numeric, brackets)
springer-basic-author-dateSpringer - Basic (author-date)
springer-fachzeitschriften-medizin-psychologieSpringer - Fachzeitschriften Medizin Psychologie (Deutsch)
springer-humanities-author-dateSpringer - Humanities (author-date)
springer-lecture-notes-in-computer-scienceSpringer - Lecture Notes in Computer Science
springer-mathphysSpringer - MathPhys (numeric, brackets)
springer-socpsych-author-dateSpringer - SocPsych (author-date)
springer-vancouverSpringer - Vancouver (brackets)
taylor-and-francis-chicago-author-dateTaylor & Francis - Chicago Manual of Style (author-date)
taylor-and-francis-national-library-of-medicineTaylor & Francis - National Library of Medicine
the-institution-of-engineering-and-technologyThe Institution of Engineering and Technology
the-lancetThe Lancet
thiemeThieme-German (Deutsch)
trendsTrends journals
turabian-author-dateTurabian 9th edition (author-date)
turabian-fullnote-8Turabian 8th edition (full note)
vancouverVancouver
vancouver-superscriptVancouver (superscript)
Default value: "ieee"