https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin

Location-based breadcrumbs navigation.
https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin

Last synced: about 1 month ago
JSON representation

Location-based breadcrumbs navigation.

• Host: GitHub
• URL: https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin
• Owner: mihaigalos
• License: mit
• Created: 2024-06-15T19:51:20.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-06T05:09:41.000Z (2 months ago)
• Last Synced: 2024-09-26T20:39:21.152Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 55.7 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-breadcrumbs-plugin

Mkdocs location-based breadcrumbs navigation.

These directly get prepended to rendered Markdown.

![screenshot](https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin/raw/main/screenshots/mkdocs-breadcrumbs-plugin.png)

## Setup

Install the plugin using pip:

```bash

pip install mkdocs-breadcrumbs-plugin

```

Activate the plugin in `mkdocs.yaml`:

```yaml

plugins:

  - 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

```