mkdocs-breadcrumbs-plugin
Mkdocs location-based breadcrumbs navigation.
These directly get prepended to rendered Markdown.
Setup
Install the plugin using pip:
pip install mkdocs-breadcrumbs-plugin
Activate the plugin in mkdocs.yaml:
plugins:
- mkdocs-breadcrumbs-plugin:
delimiter: " / " # separator between sections
log_level: "WARNING" # "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
exclude_paths:
- "docs/mkdocs/**"
- "docs/mkdocs" # avoid generating index.md
additional_index_folders:
- temp_dir
generate_home_index: false
use_page_titles: true # use page title instead of path in breadcrumbs
home_text: "Home"
Development
Running Tests
To run the tests, use the following command:
pytest
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-breadcrumbs-plugin 0.1.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_breadcrumbs_plugin-0.1.14.tar.gz | 7.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_breadcrumbs_plugin-0.1.14-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.7 kB
Release files / mkdocs_breadcrumbs_plugin-0.1.14.tar.gz
| Download URL | mkdocs_breadcrumbs_plugin-0.1.14.tar.gz |
|---|---|
| Size | 7.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eb3e13505369e2323a1a6b2f9a978cbc3770caee191da361d7acdf15dc13ba8d
|
|
BLAKE2b-256 checksum How to use checksums |
ed58406e5e52cfe1d23596c31863f965b09b771f549ee4564c6a2cebaab1635b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 18, 2025.
Transparency logRelease files / mkdocs_breadcrumbs_plugin-0.1.14-py3-none-any.whl
| Download URL | mkdocs_breadcrumbs_plugin-0.1.14-py3-none-any.whl |
|---|---|
| Size | 8.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
26fb5a427a1d8e2807e72f95b936023bb4025c2bda1f88a242d2b5ac55340c13
|
|
BLAKE2b-256 checksum How to use checksums |
46884319123966dcf13343cb90b2cec0296698489233e56b18b35bd83c12c016
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 18, 2025.
Transparency log
