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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocsi-1.4.5.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for mkdocsi-1.4.5.tar.gz
Algorithm Hash digest
SHA256 ca6ccf94842a899d28c50f7fb134f3ff73828ebb76a6d41031dae8cb637ea09f
MD5 b623afe309cf3972d05e543e47dc6583
BLAKE2b-256 5f8de4ded36ad8c658af51a73c9b0af3fd1500ea84862193fbc5f15f61405d33

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocsi-1.4.5-py3-none-any.whl
  • Upload date:
  • Size: 3.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for mkdocsi-1.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c191775d6406d6744b3682eeb2104eac2cdfb288d3a9d47a8792bbc258d6e746
MD5 7c96b7cb4d93d82230815017af1f9670
BLAKE2b-256 ae612139aa27274f4d464426212a1e1c04704210655ba157c4ed74ea6197d33c

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