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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.9.tar.gz
Algorithm Hash digest
SHA256 366b3a2113e43b348dd6947115870ecb6c7aada6331486134ea7bc6ec218fa79
MD5 df0ea70b39a686059463e9b773f1ea06
BLAKE2b-256 da63a2cdaf09c584824dae306362925b441ae423ea88672fe53c933a204b134d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 136f34f378d8dbe995ccff4334837cfd6a308fcbed69d4d6f5fcc6f63cf034d2
MD5 9334debb68149a23c6df56df30caba78
BLAKE2b-256 7f355498e898d61608981dfcad6ba710e25040fd8936f87f497e49f0e374f435

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