Skip to main content

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


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.5.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

mkdocsi-1.3.5-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file mkdocsi-1.3.5.tar.gz.

File metadata

  • Download URL: mkdocsi-1.3.5.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

Hashes for mkdocsi-1.3.5.tar.gz
Algorithm Hash digest
SHA256 87dd24e6b687e58aaa37bca52494633a6ae28e26532734170fa7c324b88f5a4a
MD5 69206b1fac1da6c62c90c0111405a1d7
BLAKE2b-256 2e035cdaed29e460a9b175f0f1f97f9d0f72cb0b7ab286d80d2d93bc01ca73e5

See more details on using hashes here.

File details

Details for the file mkdocsi-1.3.5-py3-none-any.whl.

File metadata

  • Download URL: mkdocsi-1.3.5-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for mkdocsi-1.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5e259043e5ced7d4ab0156b43e7d2bff8d5bd9c0d9f764d9e0de0a28292c7d7c
MD5 aab39d006fae37e39a39985fec17cb7f
BLAKE2b-256 1b29d1ad13a2abc941651d8bac8e10cf0929e8d804d76a0ea6478ec8ca154d80

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page