Skip to main content

Location-based breadcrumbs plugin for mkdocs.

Project description

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:
  - search
  - mkdocs-breadcrumbs-plugin:
      log_level: "WARNING"  # "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.5.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.5.tar.gz
Algorithm Hash digest
SHA256 8cb82b5dfe5ecf888e2ab923b743a9b306f8cfee31670ab70b32ebfe570c5ec3
MD5 d7254732b73028ea374db26b9a92784f
BLAKE2b-256 0855e1cf3230e7581fc5872e4c7a8b31a99d5f775869cccbb8c4e04c59c68099

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d289820ba848364383adb5dead0c5f6a80a0a57b799253dee1babb8e4ebc4637
MD5 f1320a9470c481fc125d186ebe76c195
BLAKE2b-256 a6082c912ddee6f0fa834d0fa2dce91cfc7f6928e0b7a870fe35bc91b8ad90de

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