Mkdocs plugin to generate nav list from docs dir
Project description
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" will be ignored.
Configuration
Add following lines to your mkdocs.yml
configuration file:
plugins:
- gen_nav:
enabled: true
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Install
pip install mkdocs-gen-nav-plugin
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
Built Distribution
Close
Hashes for mkdocs_gen_nav_plugin-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ecd0df5474738c3ce5c619256d1619083a4f3481fb2915ad43cd40929a3ffc9 |
|
MD5 | 4fced15da5e60161dbae99de0d4fbdd8 |
|
BLAKE2b-256 | 2c50a387869c8a3caa065b43c07e6104e7105302e25d1bc9e1686cc8e4ee10bd |
Close
Hashes for mkdocs_gen_nav_plugin-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66fb5ba17b737b5a37f7eb88db5055d95a09ec5070691bad21f51044c7139a2a |
|
MD5 | 4c1fd9dfbd1b3f32592268e8b5a1c2d3 |
|
BLAKE2b-256 | b7bf80709eac6d2dd6bdb4438ab6c9489e72cbf560b6f8b1eec0c5aaba6b2af4 |