convert docs folder to mkdocs site , dynamic nested docs and folders
Project description
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 :
pip install mkdocsi
Quick start :
all agumenst passed are optionnals :
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
mkdocsi --docs=./docs --index=./README.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocsi-1.3.3.tar.gz
(3.9 kB
view details)
Built Distribution
File details
Details for the file mkdocsi-1.3.3.tar.gz
.
File metadata
- Download URL: mkdocsi-1.3.3.tar.gz
- Upload date:
- Size: 3.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f1c3bec3ce07bc9280c543008bfbefc59ec16fb3f41021c502fa3f742583626 |
|
MD5 | 61c953281b6c91d1a7d86d11fd4738bd |
|
BLAKE2b-256 | e6da1350c25c9bc5e44b3b4676714522ce3d6baeb8d28142aff266d3e9439f0a |
File details
Details for the file mkdocsi-1.3.3-py3-none-any.whl
.
File metadata
- Download URL: mkdocsi-1.3.3-py3-none-any.whl
- Upload date:
- Size: 3.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 366ce3aa6a189cbbefc3658eae5aa81d09140196f7dca7ea6a46b9d8f9847b45 |
|
MD5 | a170783445180692d2c8530e2897e08b |
|
BLAKE2b-256 | 53e1fe5be869dbee06ce1bbf94a1411c6d69e19546d2ec5839779a0737a3657e |