Skip to main content

An MkDocs plugin that enables managing citations with BibTex

Project description

testing codecov Language grade: Python


A MkDocs plugin for citation management using bibtex.


Install the plugin using pip:

pip install mkdocs-bibtex

If you're having trouble with pandoc, try installing the conda-forge version of pypandoc: conda install -c conda-forge pypandoc which will install a version with built in pandoc binaries

Next, add the following lines to your mkdocs.yml:

  - search
  - bibtex:
      bib_file: "refs.bib"
  - footnotes

The footnotes extension is how citations are linked for now.

If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set.


  • bib_file - Name of your bibtex file. Either the absolute path or the path relative to mkdocs.yml
  • bib_dir - Directory for bibtex files to load, same as above for path resolution
  • bib_command - The command for your bibliography, defaults to \bibliography
  • full_bib_command - The command for your full bibliography, defaults to \full_bibliography
  • csl_file - Bibtex CSL file to format the citation with, defaults to None, using a built in plain format instead


In your markdown files:

  1. Add your citations as you would if you used pandoc, IE: [@first_cite;@second_cite]
  2. Add in \bibliography or whatever you set your bib_command to where you want your references.
  3. Add in \full_bibliography or whatever you set your full_bib_command to where you want the full set of references. Note: This is not work just right since this plugin can't dictate the orer in which files are processed. The best way to ensure the file with the full bibliography gets processed last is to use numbers in front of file/folder names to enforce an order of processing, IE:
  4. (Optional) Setup csl_file to control the citation text formatting.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-bibtex, version 2.0.0
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs-bibtex-2.0.0.tar.gz (14.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page