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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocsi-1.4.2.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.2.tar.gz
Algorithm Hash digest
SHA256 7547abcf4ad160695acc57a5f14db30cdf2fa2206bd9d54be5636969854d079b
MD5 f944a16baaefc8d045aaeac51b1e0ab1
BLAKE2b-256 fd8fa8546045295a310e3f97559f81dd415eda385c3f6243bfdaa858bb5b9e3a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocsi-1.4.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 03608632886d8cd759dcf3769390cd411d881f7319bdbae302f208a420b4a3c3
MD5 bf49bec6f7488b72483ba1633970d9ef
BLAKE2b-256 8ed412a1f01adba892328d9edf945392e715ac33e10181f1766734dbc07235e0

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