Metadata-Version: 2.1
Name: mkdocs-breadcrumbs-plugin
Version: 0.0.3
Summary: Location-based breadcrumbs plugin for mkdocs.
Home-page: https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin
Author: Mihai Galos
Author-email: mihai@galos.one
License: MIT
Keywords: mkdocs plugin
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.0.4
Requires-Dist: mkdocs-material

# mkdocs-breadcrumbs

Experimental mkdocs location-based breadcrumbs navigation.

These directly get prepended to rendered Markdown.

![example](screenshots/breadcrumbs.png)

## Setup

Install the plugin using pip:

```bash
pip install mkdocs-breadcrumbs
```

Activate the plugin in `mkdocs.yml`:
```yaml
plugins:
  - search
  - breadcrumbs
```

## Config

* `start_depth` - An int representing at which depth the plugin is running the logic. The depth represents the number of slashes in a URL path (i.e.: /home/ has depth 2). 

