Skip to main content

Location-based breadcrumbs plugin for mkdocs.

Project description

mkdocs-breadcrumbs-plugin

Experimental mkdocs location-based breadcrumbs navigation.

These directly get prepended to rendered Markdown.

example

Setup

Install the plugin using pip:

pip install mkdocs-breadcrumbs-plugin

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - mkdocs-breadcrumbs-plugin:
      log_level: "DEBUG"  # "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
      delimiter: " / "  # separator between sections

Project details


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.0.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e1c52ec4968c01a87a25d64e846de7e9c1cd06e462ff0c8a0eb03402369587f5
MD5 de3db67384dfeb7497793782f4fab7ec
BLAKE2b-256 6464e7d411bfeeeeca13cfe17e3a79a2a9004e14c1469b8f7e4dadbc58e40e36

See more details on using hashes here.

File details

Details for the file mkdocs_breadcrumbs_plugin-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aa814aca7588e6b81b5c6e79e344fa1f85390a14f471dac943dfdb93d080eb99
MD5 4feee6094fb28c3381f288e6d83e3616
BLAKE2b-256 fc00c1cc85d4a03788261fae49f41e8d4828e722befdc0f8fe8aa81a82925346

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page