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.3.tar.gz
(3.9 kB
view details)
Built Distribution
File details
Details for the file mkdocsi-1.4.3.tar.gz
.
File metadata
- Download URL: mkdocsi-1.4.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 | c7aa01796262eab9a664424b83527caa553e9fc934a4d46007deedb665fc38b4 |
|
MD5 | 2e181b8449531c0501185379685cd485 |
|
BLAKE2b-256 | a48354d1885d870edd53791ad0536511834dc64cd22762f8dd13300d1ce20bff |
File details
Details for the file mkdocsi-1.4.3-py3-none-any.whl
.
File metadata
- Download URL: mkdocsi-1.4.3-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 | d56fc7d43f8a889b35dc11dc9f579c944c6acdbb1dfd64aa20ab1bfca38d4676 |
|
MD5 | 3fa190b30104260b08e5dc0f9c661b93 |
|
BLAKE2b-256 | c0039971e6dc20566bca14fdc25c2111dfbde0fc664fcbf02a7b93969410351e |