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.4.0.tar.gz
(3.9 kB
view details)
Built Distribution
File details
Details for the file mkdocsi-1.4.0.tar.gz
.
File metadata
- Download URL: mkdocsi-1.4.0.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 | 6ab43f67a1d505d6e6f6c0f4267fc71579f34f0acde2b42cc94d9ad85d04f1a6 |
|
MD5 | b91f727fa884116c7293321e5acfcb55 |
|
BLAKE2b-256 | ce652b2ed605c460d6951f0ec86b33f71a2b83a1c297551a5b33c49ef02ba3fc |
File details
Details for the file mkdocsi-1.4.0-py3-none-any.whl
.
File metadata
- Download URL: mkdocsi-1.4.0-py3-none-any.whl
- Upload date:
- Size: 3.5 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 | 1678032b3f15e4574ca17210636e79de187a9a6178f4ebe10b55945c227379ca |
|
MD5 | 0d63163ea927ca740b46c49afb068d75 |
|
BLAKE2b-256 | 3edd3ddd85ceafc3055ff4f8d791b24b04f0039090c026f62dd6f3150fa46212 |