mkdocs-gen-nav-plugin

Name	mkdocs-gen-nav-plugin JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	Mkdocs plugin to generate nav list from docs dir
upload_time	2024-09-30 02:40:36
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # MkDocs Gen Nav Plugin

This plugin generates the `config['nav']` automatically for your MkDocs documentation site by finding all markdown files from the global `config['docs_dir']`.

## Rules

The following rules are used to generate the navigation:

* The file or directory names are used as the navigation title.
* If a path name starts with two digits and '_' characters, it is ignored in the title. This means that it is only used to sort the navigation list.
* If a path name starts with '_', it will be ignored. This means that the links to that markdown file should be a part of some other document manually.
* The file named "index.md" in the docs root dir will be ignored. (It will be used as Home page)

## Configuration

Add following lines to your `mkdocs.yml` configuration file:

```
plugins:
  - gen_nav:
      enabled: true
```

## Example

you can find example in [examples](./examples) directory

## Install

`pip install mkdocs-gen-nav-plugin`

## Development

[Development Guide](./docs/development.md)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-gen-nav-plugin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "soonoh <soonoh.jung@gmail.com>, FrozenSource <bram.nijenkamp@dataacess.eu>",
    "download_url": "https://files.pythonhosted.org/packages/e6/de/aa8d51e188ed932b11d7c27106e121f15e0fed14ee5c1e37cbdce6f4df7f/mkdocs_gen_nav_plugin-0.2.0.tar.gz",
    "platform": null,
    "description": "# MkDocs Gen Nav Plugin\n\nThis plugin generates the `config['nav']` automatically for your MkDocs documentation site by finding all markdown files from the global `config['docs_dir']`.\n\n## Rules\n\nThe following rules are used to generate the navigation:\n\n* The file or directory names are used as the navigation title.\n* If a path name starts with two digits and '_' characters, it is ignored in the title. This means that it is only used to sort the navigation list.\n* If a path name starts with '_', it will be ignored. This means that the links to that markdown file should be a part of some other document manually.\n* The file named \"index.md\" in the docs root dir will be ignored. (It will be used as Home page)\n\n## Configuration\n\nAdd following lines to your `mkdocs.yml` configuration file:\n\n```\nplugins:\n  - gen_nav:\n      enabled: true\n```\n\n## Example\n\nyou can find example in [examples](./examples) directory\n\n## Install\n\n`pip install mkdocs-gen-nav-plugin`\n\n## Development\n\n[Development Guide](./docs/development.md)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Mkdocs plugin to generate nav list from docs dir",
    "version": "0.2.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/vrerv/mkdocs-gen-nav-plugin/issues",
        "Homepage": "https://github.com/vrerv/mkdocs-gen-nav-plugin"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "29eeb4e796ad8cd162a809577d157207c4b3b45d94691f0ce7cae49c28aafa7f",
                "md5": "37449de4d11966f31c0e08edcf0cbc4f",
                "sha256": "2c6e5b4f8d9cf3e00d872e71617b283725bd83da802784d1698e5e60c7522472"
            },
            "downloads": -1,
            "filename": "mkdocs_gen_nav_plugin-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "37449de4d11966f31c0e08edcf0cbc4f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 7589,
            "upload_time": "2024-09-30T02:40:35",
            "upload_time_iso_8601": "2024-09-30T02:40:35.287861Z",
            "url": "https://files.pythonhosted.org/packages/29/ee/b4e796ad8cd162a809577d157207c4b3b45d94691f0ce7cae49c28aafa7f/mkdocs_gen_nav_plugin-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e6deaa8d51e188ed932b11d7c27106e121f15e0fed14ee5c1e37cbdce6f4df7f",
                "md5": "5dc65559e162350fc41148d2f2ad0e27",
                "sha256": "9dfb3dac3f5e3a195cfdb48c8ccb80af6878c3c8d368e5e4171d4488f55e80ed"
            },
            "downloads": -1,
            "filename": "mkdocs_gen_nav_plugin-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5dc65559e162350fc41148d2f2ad0e27",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 11249,
            "upload_time": "2024-09-30T02:40:36",
            "upload_time_iso_8601": "2024-09-30T02:40:36.606226Z",
            "url": "https://files.pythonhosted.org/packages/e6/de/aa8d51e188ed932b11d7c27106e121f15e0fed14ee5c1e37cbdce6f4df7f/mkdocs_gen_nav_plugin-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-30 02:40:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "vrerv",
    "github_project": "mkdocs-gen-nav-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-gen-nav-plugin"
}