Skip to main content

Location-based breadcrumbs plugin for mkdocs.

Project description

mkdocs-breadcrumbs

Experimental mkdocs location-based breadcrumbs navigation.

These directly get prepended to rendered Markdown.

example

Setup

Install the plugin using pip:

pip install mkdocs-breadcrumbs

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - breadcrumbs

Config

  • start_depth - An int representing at which depth the plugin is running the logic. The depth represents the number of slashes in a URL path (i.e.: /home/ has depth 2).

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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.0.3.tar.gz
Algorithm Hash digest
SHA256 650a6e0938398c6c739b2066b8832c265ce345b8bfdcf89637f2885859ba43c3
MD5 a79b9ac0ded08a285caebd876beca400
BLAKE2b-256 64c973a9d6c0c2d04d0b66c9d6b4fe5a20ec0f39296e593ae09ae90a95bb3986

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 89fa8bb62e3916ae8ca2ac9edba2eb36192697b84fe236b5c5df5fffe06a9418
MD5 9197531a885e7f78ffbac38ed54fac54
BLAKE2b-256 6c1d3ead20ccdcb2f03642f2255a8503830257ba54577683f6bb0e5dedcd941f

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