mkdocs-breadcrumbs-plugin

Name	mkdocs-breadcrumbs-plugin JSON
Version	0.1.11 JSON
	download
home_page	https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin
Summary	Location-based breadcrumbs plugin for mkdocs.
upload_time	2025-02-20 21:12:33
maintainer	None
docs_url	None
author	Mihai Galos
requires_python	>=3.8
license	MIT
keywords	mkdocs plugin
VCS
bugtrack_url
requirements	mkdocs
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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
      use_page_titles: true # use page title instead of path in breadcrumbs
      home_text: "Home"
```


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin",
    "name": "mkdocs-breadcrumbs-plugin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "mkdocs plugin",
    "author": "Mihai Galos",
    "author_email": "mihai@galos.one",
    "download_url": "https://files.pythonhosted.org/packages/76/04/a9291d215bea0099a523e5820f7b4cce1b061244f7fe7f0b90da4b79093f/mkdocs_breadcrumbs_plugin-0.1.11.tar.gz",
    "platform": null,
    "description": "# mkdocs-breadcrumbs-plugin\n\nMkdocs location-based breadcrumbs navigation.\n\nThese directly get prepended to rendered Markdown.\n\n![screenshot](https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin/raw/main/screenshots/mkdocs-breadcrumbs-plugin.png)\n\n## Setup\n\nInstall the plugin using pip:\n\n```bash\npip install mkdocs-breadcrumbs-plugin\n```\n\nActivate the plugin in `mkdocs.yaml`:\n```yaml\nplugins:\n  - mkdocs-breadcrumbs-plugin:\n      delimiter: \" / \"  # separator between sections\n      log_level: \"WARNING\"  # \"DEBUG\", \"INFO\", \"WARNING\", \"ERROR\", \"CRITICAL\"\n      exclude_paths:\n        - \"docs/mkdocs/**\"\n        - \"docs/mkdocs\"   # avoid generating index.md\n      additional_index_folders:\n        - temp_dir\n      generate_home_index: false\n      use_page_titles: true # use page title instead of path in breadcrumbs\n      home_text: \"Home\"\n```\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Location-based breadcrumbs plugin for mkdocs.",
    "version": "0.1.11",
    "project_urls": {
        "Homepage": "https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin"
    },
    "split_keywords": [
        "mkdocs",
        "plugin"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "66b63a5bff2c796da3f516cca53b5fdf23411d7dd9d9bd51ba66c46f294d8a86",
                "md5": "6fed9220420e62bae9a2f789dc9baf64",
                "sha256": "db16b29d36bba1660ee3300c6c114cdca89998ff3ca603f26f2de317ff3aa944"
            },
            "downloads": -1,
            "filename": "mkdocs_breadcrumbs_plugin-0.1.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6fed9220420e62bae9a2f789dc9baf64",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5751,
            "upload_time": "2025-02-20T21:12:32",
            "upload_time_iso_8601": "2025-02-20T21:12:32.160794Z",
            "url": "https://files.pythonhosted.org/packages/66/b6/3a5bff2c796da3f516cca53b5fdf23411d7dd9d9bd51ba66c46f294d8a86/mkdocs_breadcrumbs_plugin-0.1.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7604a9291d215bea0099a523e5820f7b4cce1b061244f7fe7f0b90da4b79093f",
                "md5": "b5f7e057169955c692e4a97c4ddb2293",
                "sha256": "8aef23d66821b7f0d8518656affe1f1fe57028afce764e49e8bcf61dc0c72b5f"
            },
            "downloads": -1,
            "filename": "mkdocs_breadcrumbs_plugin-0.1.11.tar.gz",
            "has_sig": false,
            "md5_digest": "b5f7e057169955c692e4a97c4ddb2293",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5000,
            "upload_time": "2025-02-20T21:12:33",
            "upload_time_iso_8601": "2025-02-20T21:12:33.363419Z",
            "url": "https://files.pythonhosted.org/packages/76/04/a9291d215bea0099a523e5820f7b4cce1b061244f7fe7f0b90da4b79093f/mkdocs_breadcrumbs_plugin-0.1.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-20 21:12:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mihaigalos",
    "github_project": "mkdocs-breadcrumbs-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "mkdocs",
            "specs": []
        }
    ],
    "lcname": "mkdocs-breadcrumbs-plugin"
}