Metadata-Version: 2.1
Name: mkdocsi
Version: 1.3.6
Summary: convert docs folder to mkdocs site , dynamic nested docs and folders
Home-page: https://gitlab.com/isampypi/mkdocsi
Author: Mhadhbi Issam
Author-email: mhadhbixissam@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: mkdocs
Requires-Dist: mkdocs-material

# mkdocsi : 

## Why  : 
consider you have nested folders that have makrdown documentation and want tool that convert them to website dynamiccly build the sute map urls according to path to url .



## Installation : 
```bash
pip install mkdocsi
```

## Quick start : 
all agumenst passed are optionnals  : 
```bash
python -m mkdocsi --docs=./docs --index=./README.md --site_name=documentation --mkdocs=./mkdocs.yml
```
when it come to doc repo git its handy to consider README.md as home page and have `docs` folder have all makdown files 

```bash
mkdocsi --docs=./docs --index=./README.md 
```
