https://github.com/vrerv/mkdocs-gen-nav-plugin
Mkdocs plugin for generating navigation by directory structure
https://github.com/vrerv/mkdocs-gen-nav-plugin
Last synced: about 1 year ago
JSON representation
Mkdocs plugin for generating navigation by directory structure
- Host: GitHub
- URL: https://github.com/vrerv/mkdocs-gen-nav-plugin
- Owner: vrerv
- License: apache-2.0
- Created: 2023-02-25T09:23:23.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-30T02:43:50.000Z (over 1 year ago)
- Last Synced: 2025-04-12T02:39:12.535Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 29.3 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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)