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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.2.tar.gz
Algorithm Hash digest
SHA256 bb467335e3a6e9040f645fb8c105d13162235147325abec4028befb850963302
MD5 add45a805296e358b4fe164a52f43b12
BLAKE2b-256 612c2f10a715fdbc262e290753e1f9c6afc0ead323db9a91023013331405e049

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3ae3e10c9a5d79a90fa99cfb15ba4e824d40803d1d8b2b9403127a00cae545dc
MD5 b5712e5d0be103b9e84289bc3e5a70df
BLAKE2b-256 0a36648fea99966f32d0a1200e20858b0ef7ff6780134b3fd38dbc9798aff191

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