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.1.tar.gz
(3.9 kB
view details)
Built Distribution
File details
Details for the file mkdocsi-1.4.1.tar.gz
.
File metadata
- Download URL: mkdocsi-1.4.1.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 | ad827cd7f0364f7ec11fe6c2e399931f510006f17a77f2254608ac9adfd04709 |
|
MD5 | d0690fc6905cf8f62e2209f6ae3ddd00 |
|
BLAKE2b-256 | e166a8f5db00f9fa84387ce660432edeb196d601c0b1bdc1c4751bc7a3d648b4 |
File details
Details for the file mkdocsi-1.4.1-py3-none-any.whl
.
File metadata
- Download URL: mkdocsi-1.4.1-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 | 6ea96f880c5a813286084a4f7835daee09e6b28497045c84b559028bcf21509d |
|
MD5 | 3c2f4f21a38ef48de1439b87516adbb2 |
|
BLAKE2b-256 | ba61cabd82f33419b448f3d2620b8687940655676f6d71fbee9bd2a61077c273 |