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 instead
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.
Metadata
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)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-bibtex-0.3.0.tar.gz | 10.0 kB | Without provenance | Details for mkdocs-bibtex-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_bibtex-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_bibtex-0.3.0-py3-none-any.whl |
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 | |
|
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 | |
|
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
|
Security for mkdocs-bibtex 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.