Skip to main content

Location-based breadcrumbs.

Project description

mkdocs-breadcrumbs

Experimental mkdocs location-based breadcrumbs navigation.

These directly get prepended to rendered Markdown.

example

Setup

Install the plugin using pip:

pip install mkdocs-breadcrumbs

Activate the plugin in mkdocs.yml:

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).

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-0.0.3.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_breadcrumbs-0.0.3-py3-none-any.whl (3.5 kB view hashes)

Uploaded Python 3

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