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

Uploaded Source

Built Distribution

mkdocsi-1.4.4-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocsi-1.4.4.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.4.4.tar.gz
Algorithm Hash digest
SHA256 8385b4ac03ed4054e7336334dafb4bfbf0fa52c6aaf68773bc37b8f5f910b1ed
MD5 1cce3c40c49216f259393cc1d67924b3
BLAKE2b-256 11d9c3616c95a25c56cbcd25c0ebdf5ebb49e1dbc658378fb6d4dd4b38456691

See more details on using hashes here.

File details

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

File metadata

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

Hashes for mkdocsi-1.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ce767d85beeada938ad98d78f1da840b2f2352751167e69cee0c82926679e46c
MD5 9fd4040451de5d3dcbadb9458a01a06c
BLAKE2b-256 26f1125aac949876d4bc573324d0c7524a3c7c3b156e6d443fd932abc18c7714

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