mkdocs-breadcrumbs-plugin 0.1.10

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:
        delimiter: " / "  # separator between sections
        log_level: "WARNING"  # "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
        exclude_paths:
          - "docs/mkdocs/**"
          - "docs/mkdocs"   # avoid generating index.md
        additional_index_folders:
          - temp_dir
        generate_home_index: false