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

Uploaded Source

Built Distribution

mkdocsi-1.3.7-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocsi-1.3.7.tar.gz
  • Upload date:
  • Size: 3.8 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.7.tar.gz
Algorithm Hash digest
SHA256 42a5452355ec3c6a8ae17dcbf78b168addbed779b369715563d72bb903896ff4
MD5 affbf3f90b1ef33ad825904129f8d39b
BLAKE2b-256 feee04d9bd4ebdfa1bf232d32e3c7f086d5c949e1b052c4d40104324e76677cf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocsi-1.3.7-py3-none-any.whl
  • Upload date:
  • Size: 3.4 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e89c42d64b2d5f70ac7ef6a7e2e8167f2d305652f7fa2f77ec4f1b2c05a76ef4
MD5 02458c2c99fc9c70acff65b9977642b7
BLAKE2b-256 5571164ea7c029d76a9205b6bbd6821ed6c1c90e5b762ef23c9bb6f9322cbe21

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