mkdocs-bibtex

A MkDocs plugin for citation management using bibtex.

Setup

Install the plugin using pip:

pip install mkdocs-bibtex

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

plugins:
  - search
  - bibtex:
      bib_file: "refs.bib"
      cite_style: "pandoc"

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.

Options

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
cite_style - The way you place citations into text: "pandoc" for [@myRef] and "plain" for @myRef
bib_command - The command for your bibliography, defaults to \bibliography
full_bib_command - The command for your 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

Usage

In your markdown files:

Add your citations as you would normally using either "plain" or "pandoc" style
Add in \bibliography or whatever you set your bib_command to where you want your references.
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 guaranteed to work yet since one issue is the order in which markdown files are processed. Might need to do something using the on_files() event first.
(Optional) Setup csl_file to control the citation text formatting.

Release files for mkdocs-bibtex 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-bibtex 0.3.0
File	Size	Uploaded
mkdocs-bibtex-0.3.0.tar.gz	10.0 kB	Jun 28, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-bibtex 0.3.0
File	Interpreter	ABI	Platform	Reset
mkdocs_bibtex-0.3.0-py3-none-any.whl 7.4 kB Jun 28, 2020	Python 3	none	any	Details

Total release size: 17.3 kB

Release files / mkdocs-bibtex-0.3.0.tar.gz

Download URL	mkdocs-bibtex-0.3.0.tar.gz
Size	10.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`b97a484e2927921c58f8b6b7d32b2d845b2d5738e74ad086a4aaf3d1c2911f59`
BLAKE2b-256 checksum How to use checksums	`b100dc98658fe852932dbb02c53687f8f5e776d8c2946105c14fe85bdf9ba1f2`
Upload date	Jun 28, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3`

Release files / mkdocs_bibtex-0.3.0-py3-none-any.whl

Download URL	mkdocs_bibtex-0.3.0-py3-none-any.whl
Size	7.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1f00604d1cfad5f9b9a4d2b1513cfc0aa5ac7f0a1e092cdc341aac0e044eacaf`
BLAKE2b-256 checksum How to use checksums	`570cc1447376ea8d536eccd4da452725517eb48eee26fd6cf8fa9afe47dfa1c7`
Upload date	Jun 28, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3`