Skip to content

Citations

The bibtex plugin understands Pandoc-style citations and builds a references section for any cited works. Entries come from docs/references.bib, and you can also declare ad-hoc references inside a page.

Demo

The material theme is used throughout these docs Squidfunk, 2024 and Pret is used for the interactive example Wajsburt, 2024. Citations can be combined or re-used multiple times without repeating the bibliography entry.

Need to cite something not in the BibTeX file? Define it inline like [@demo-ref] above and it will show up in the references list.

Code

For instance in this page:

Some text that cites mkdocs [@mkdocs-material] and mkdocs-eds [@demo-ref].

[@demo-ref]: Wajsburt, 2024. Documentation prototypes with mkdocs-eds.

Some more text.

Make sure to enable the bibtex plugin in your mkdocs.yml:

plugins:
    ...
    - bibtex:
        bib_file: references.bib
    ...

  1. Squidfunk., 2024. Material for MkDocs. https://squidfunk.github.io/mkdocs-material/

  2. Wajsburt P., 2024. Pret. https://github.com/percevalw/pret

  3. Wajsburt, 2024. Documentation prototypes with mkdocs-eds.