mkdocs-breadcrumbs-plugin 0.1.3

Location-based breadcrumbs plugin for mkdocs.

mkdocs-breadcrumbs-plugin

Mkdocs location-based breadcrumbs navigation.

These directly get prepended to rendered Markdown.

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

[!IMPORTANT]
This plugin will recursively scan folders for the first markdown document. If a subpath contains no markdown, clicking it in the produce breadcrumb will match the next available document.