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.6.tar.gz
(3.8 kB
view details)
Built Distribution
File details
Details for the file mkdocsi-1.3.6.tar.gz
.
File metadata
- Download URL: mkdocsi-1.3.6.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 | 33ecbb23993960036540a3cb040fc21edfd9ea77a9759514e219b41b3a8450ed |
|
MD5 | 22d791cc7e5d4bf3cf260ea3d0edb936 |
|
BLAKE2b-256 | 8c792cb70c5a9d82cbf43e052d94993d3275a1a8f8c1a3a00a277178836e8294 |
File details
Details for the file mkdocsi-1.3.6-py3-none-any.whl
.
File metadata
- Download URL: mkdocsi-1.3.6-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 | 551bc41a5b608312c6ee7a44930a6782924d4871582ae6f848b8eb9e63aaf7db |
|
MD5 | 40a17432f827297c4441f401748c478b |
|
BLAKE2b-256 | a258aae11a0d3cdd644f78a837dae97c6f30086e824c097615a6ff4363dc587d |