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_bibliography
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.
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.2.3.tar.gz
(8.0 kB
view details)
Built Distribution
File details
Details for the file mkdocs-bibtex-0.2.3.tar.gz.
File metadata
- Download URL: mkdocs-bibtex-0.2.3.tar.gz
- Upload date:
- Size: 8.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 58dc67d90b8b4ecf51df77f5bc5d5a7506834106212f28d6ec529a3a6eab7b74 |
|
| MD5 | 6f6a547427eab20053a96050a11c9e62 |
|
| BLAKE2b-256 | e112831c5153e4ff360efca55f77719f0db016adf2790ea318ec72cc59a181ed |
File details
Details for the file mkdocs_bibtex-0.2.3-py3-none-any.whl.
File metadata
- Download URL: mkdocs_bibtex-0.2.3-py3-none-any.whl
- Upload date:
- Size: 6.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0e55cde441482e582d6e68bc4e05fdf0b43ed7779d54c6de2896a70a36ff8912 |
|
| MD5 | fa7a9ed0fca72711185d24f28ce57aad |
|
| BLAKE2b-256 | d4677905588433f27a237fecb3b7d7faaed752e1c1b5c438f45ff14af7a7a89a |
