mkdocs-breadcrumbs-plugin

Mkdocs location-based breadcrumbs navigation.

These directly get prepended to rendered Markdown.

screenshot

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_breadcrumbs_plugin-0.1.14.tar.gz (7.3 kB view details)

Uploaded Apr 18, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

mkdocs_breadcrumbs_plugin-0.1.14-py3-none-any.whl (8.4 kB view details)

Uploaded Apr 18, 2025 Python 3

File details

Details for the file mkdocs_breadcrumbs_plugin-0.1.14.tar.gz.

File metadata

Download URL: mkdocs_breadcrumbs_plugin-0.1.14.tar.gz
Upload date: Apr 18, 2025
Size: 7.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.14.tar.gz
Algorithm	Hash digest
SHA256	`eb3e13505369e2323a1a6b2f9a978cbc3770caee191da361d7acdf15dc13ba8d`
MD5	`3295e795c1e0175e6f4ab01659d933d5`
BLAKE2b-256	`ed58406e5e52cfe1d23596c31863f965b09b771f549ee4564c6a2cebaab1635b`

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_breadcrumbs_plugin-0.1.14.tar.gz:

Publisher: cd.yaml on mihaigalos/mkdocs-breadcrumbs-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: mkdocs_breadcrumbs_plugin-0.1.14.tar.gz
- Subject digest: eb3e13505369e2323a1a6b2f9a978cbc3770caee191da361d7acdf15dc13ba8d
- Sigstore transparency entry: 199249825
- Sigstore integration time: Apr 18, 2025
Source repository:
- Permalink: mihaigalos/mkdocs-breadcrumbs-plugin@0b7239ea181979a724cbafd92d6dc7db3a024d4c
- Branch / Tag: refs/tags/0.1.14
- Owner: https://github.com/mihaigalos
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: cd.yaml@0b7239ea181979a724cbafd92d6dc7db3a024d4c
- Trigger Event: workflow_dispatch