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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocsi-1.3.4.tar.gz
  • Upload date:
  • Size: 4.0 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.4.tar.gz
Algorithm Hash digest
SHA256 128e518d077bc8d9d816139b87f40fb0cf1ec5f90d014f963227183ecfcd86ca
MD5 c3cc637384de50cccecd6eb3c036c9ea
BLAKE2b-256 aecd3381766b44c400300e53d0e39b86caa68fc03a090df82d2037d7ee3e4eba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocsi-1.3.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 54bcc9a26018d7a8a3021ec09e14b67daef8f387e4c2825e2b53d74841dc0f8c
MD5 83618908c0823daf3992cbf966b913b8
BLAKE2b-256 9073f886ef4f4cfe65004b2526ca2959b07f744504ed4238bcd513a7bf9c7184

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