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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.8.tar.gz
Algorithm Hash digest
SHA256 79b2ce8c189d176060bef31a50b284fd72a3fb4cb9aa34030b8d161a26c387c0
MD5 5a602bf6dcf8210f04b1cc4f8568dbec
BLAKE2b-256 2eb8effa5356a0d858f17c172e9b46077a91229c389e8dafa9cef8fd07063656

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d7bdcc34fbba6b46d62ac52645d3c09f84bf2b20a1ebeb9178ceeed3768bc7a3
MD5 8d310fd23548343ba0057d71b0f2a910
BLAKE2b-256 a067bce7ba24e3d4a9513e90f0b5d399656ade350dcc93ad6397f6f581d7cd29

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