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.8.tar.gz
(3.8 kB
view details)
Built Distribution
File details
Details for the file mkdocsi-1.3.8.tar.gz
.
File metadata
- Download URL: mkdocsi-1.3.8.tar.gz
- Upload date:
- Size: 3.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a20f1963ffef302b17065551a37d1185a7afcb5a09e2e04323e75aeca7386db |
|
MD5 | 120d3ee8d589e78248d87e2af7966527 |
|
BLAKE2b-256 | 140f4df8a32fd62928180e72c0f860b352df16a31b559d154b6052a566a76153 |
File details
Details for the file mkdocsi-1.3.8-py3-none-any.whl
.
File metadata
- Download URL: mkdocsi-1.3.8-py3-none-any.whl
- Upload date:
- Size: 3.4 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 | d5efdaeb06fc7a60ae8a73eb834e41e5423337a7deaff92619ecb506aacbfa24 |
|
MD5 | 91259270d947792ed1a0f5ba9c2659ac |
|
BLAKE2b-256 | 5aa89cf8827cfcd294899403cb18e77ef94a64f7d2b410eeb3c8606f377a3557 |