An MkDocs plugin that enables managing citations with BibTex
Project description
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
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set.
Options
bib_file- Name of your bibtex file. Either the absolute path or the path relative tomkdocs.ymlbib_dir- Directory for bibtex files to load, same as above for path resolutioncite_style- The way you place citations into text: "pandoc" for[@myRef]and "plain" for@myRefbib_command- The command for your bibliography, defaults to\bibliographyfull_bib_command- The command for your bibliography, defaults to\full_bibliographycsl_file- Bibtex CSL file to format the citation with, defaults to None, using a built in plain format insteadunescape_for_arithmatex- Optional; set toTrueto avoid the\(\)issue with pymdownx.arithmatex
Usage
In your markdown files:
- Add your citations as you would normally using either "plain" or "pandoc" style
- Add in
\bibliographyor whatever you set yourbib_commandto where you want your references. - Add in
\full_bibliographyor whatever you set yourfull_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 theon_files()event first. - (Optional) Setup
csl_fileto control the citation text formatting.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocs-bibtex-0.4.0.tar.gz
(10.5 kB
view details)
File details
Details for the file mkdocs-bibtex-0.4.0.tar.gz.
File metadata
- Download URL: mkdocs-bibtex-0.4.0.tar.gz
- Upload date:
- Size: 10.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 643a801d2a64af4eefb8028a8354c381550f74ec451d0661e34d782c059431bc |
|
| MD5 | a7b4a94397ac3a65f9f37a2442f5023c |
|
| BLAKE2b-256 | 61d5bf214cfccdd14ab5817341784da9c21fc1950be9ca8daa1b5c65dbd34300 |
