mkdocs-breadcrumbs

Name	mkdocs-breadcrumbs JSON
Version	0.0.3 JSON
	download
home_page	https://github.com/mihaigalos/mkdocs-breadcrumbs
Summary	Location-based breadcrumbs.
upload_time	2024-06-16 10:56:12
maintainer	None
docs_url	None
author	Mihai Galos
requires_python	>=3.8
license	MIT
keywords	mkdocs plugin
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mihaigalos/mkdocs-breadcrumbs",
    "name": "mkdocs-breadcrumbs",
    "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/6b/0d/fb6ff38d2b09d3a13d320cabb15c4d562c92a69e022d6b13083caa0d7a57/mkdocs_breadcrumbs-0.0.3.tar.gz",
    "platform": null,
    "description": "# mkdocs-breadcrumbs\n\nExperimental mkdocs location-based breadcrumbs navigation.\n\nThese directly get prepended to rendered Markdown.\n\n![example](screenshots/breadcrumbs.png)\n\n## Setup\n\nInstall the plugin using pip:\n\n```bash\npip install mkdocs-breadcrumbs\n```\n\nActivate the plugin in `mkdocs.yml`:\n```yaml\nplugins:\n  - search\n  - breadcrumbs\n```\n\n## Config\n\n* `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). \n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Location-based breadcrumbs.",
    "version": "0.0.3",
    "project_urls": {
        "Homepage": "https://github.com/mihaigalos/mkdocs-breadcrumbs"
    },
    "split_keywords": [
        "mkdocs",
        "plugin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8df85cedf36ff0976b7482dbad13ef92dd1901cd9e6807b72b541b594edc4394",
                "md5": "6844648b767258a05b19f42c7605c718",
                "sha256": "caf15e951dff26d7f8487ea0b722e9312271497d4033bb22c57a342919aeea95"
            },
            "downloads": -1,
            "filename": "mkdocs_breadcrumbs-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6844648b767258a05b19f42c7605c718",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 3541,
            "upload_time": "2024-06-16T10:56:11",
            "upload_time_iso_8601": "2024-06-16T10:56:11.887951Z",
            "url": "https://files.pythonhosted.org/packages/8d/f8/5cedf36ff0976b7482dbad13ef92dd1901cd9e6807b72b541b594edc4394/mkdocs_breadcrumbs-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6b0dfb6ff38d2b09d3a13d320cabb15c4d562c92a69e022d6b13083caa0d7a57",
                "md5": "48cc38eb54123cc1ef89ade69055d3b8",
                "sha256": "a614ad7a4d6275941f8336fc82ca95bb150f6ce0a0de6b5761dde92420996cf1"
            },
            "downloads": -1,
            "filename": "mkdocs_breadcrumbs-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "48cc38eb54123cc1ef89ade69055d3b8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 2929,
            "upload_time": "2024-06-16T10:56:12",
            "upload_time_iso_8601": "2024-06-16T10:56:12.923930Z",
            "url": "https://files.pythonhosted.org/packages/6b/0d/fb6ff38d2b09d3a13d320cabb15c4d562c92a69e022d6b13083caa0d7a57/mkdocs_breadcrumbs-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-16 10:56:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mihaigalos",
    "github_project": "mkdocs-breadcrumbs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "mkdocs-breadcrumbs"
}