Metadata-Version: 2.1
Name: mkdocs-gen-nav-plugin
Version: 0.0.2
Summary: Mkdocs plugin to generate nav list from docs dir
Project-URL: Homepage, https://github.com/vrerv/mkdocs-gen-nav-plugin
Project-URL: Bug Tracker, https://github.com/vrerv/mkdocs-gen-nav-plugin/issues
Author-email: soonoh <soonoh.jung@gmail.com>
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# 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`
