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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.7.tar.gz
Algorithm Hash digest
SHA256 33c73146515cad68469e8d41a3cf155867e97fe295c33dbddfe21a8d81ae22f6
MD5 feb1e69606083a706d8b356f84dcc4db
BLAKE2b-256 315deab5a7bd8fd8f7688ee4c22f5787e7f2e458924f4658a84d29246df63384

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_breadcrumbs_plugin-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4fc3acade389aabc9f95be99b9d5aa2d46adb0273489496e5818c1349c369552
MD5 53e37af21583248ce5152c0bbf3435db
BLAKE2b-256 fd67b40ea835fa61314e7b70dda965a536d8fcd074afdf2d7c4bb5b41beada82

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