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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a9c7d161d2e66b095d46f307143d9de2fde3f941102a9afec4384eb20826fb1f
MD5 a403b34cf71fd245a6404bcd6a27da7f
BLAKE2b-256 35308965fb8dd1a72c4c2f5fdb31d3abbbcdef20f72cc452647c2e94a484708e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 38dd955a7ca6dbb20a31405137a66ed03346fa1c3974015dccf6c52d353082f3
MD5 9a89f77c5b96eae0e8109b2089c870e4
BLAKE2b-256 a862626b7fdd18b48be64466d9dc99f7e31de82e46d33a43b23308bc27ae664c

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