An MkDocs plugin that enables managing citations with BibTex
A MkDocs plugin for citation management using bibtex.
Install the plugin using pip:
pip install mkdocs-bibtex
Next, add the following lines to your
plugins: - search - bibtex: bib_file: "refs.bib" cite_style: "pandoc"
If you have no
pluginsentry in your config file yet, you'll likely also want to add the
searchplugin. MkDocs enables it by default if there is no
bib_file- Name of your bibtex file. Either the absolute path or the path relative to
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
bib_command- The command for your bibliography, defaults to
full_bib_command- The command for your bibliography, defaults to
csl_file- Bibtex CSL file to format the citation with, defaults to None, using a built in plain format instead
In your markdown files:
- Add your citations as you would normally using either "plain" or "pandoc" style
- Add in
\bibliographyor whatever you set your
bib_commandto where you want your references.
- Add in
\full_bibliographyor whatever you set your
full_bib_commandto 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
- (Optional) Setup
csl_fileto control the citation text formatting.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size mkdocs_bibtex-0.3.1-py3-none-any.whl (7.4 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size mkdocs-bibtex-0.3.1.tar.gz (10.0 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for mkdocs_bibtex-0.3.1-py3-none-any.whl