Documentation generator from markdown files
Project description
Madoc
What for ?
It is a terminal tool to automatically generate a single html documentation file from all the .md files found in the directory.
Cool stuff to join a clean and easy to read documentation to some project.
Installation
pip install madoc
Usage
Open a terminal in the directory where are the .md files you whant to use for your documentation,
and just type
madoc
done, you have your documentation in a single html file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
madoc-1.0.1.tar.gz
(4.6 kB
view details)
Built Distribution
madoc-1.0.1-py3-none-any.whl
(5.1 kB
view details)
File details
Details for the file madoc-1.0.1.tar.gz
.
File metadata
- Download URL: madoc-1.0.1.tar.gz
- Upload date:
- Size: 4.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e8d4a637b7bdba1382392607148d2699c504802aaadf14413634677ef724539 |
|
MD5 | d022bb456307be3bcadbda92243fcfd1 |
|
BLAKE2b-256 | 7c06b213c2987b3dc0cf0bab875351104c3282bdddd0f9dbdebc453ca603a9b5 |
File details
Details for the file madoc-1.0.1-py3-none-any.whl
.
File metadata
- Download URL: madoc-1.0.1-py3-none-any.whl
- Upload date:
- Size: 5.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2c84cd59ed5fa14d891af2799560140d6cccb4dd55a2624f5f8649bc43a8221 |
|
MD5 | a957b297c0bb852da27a295e6eb4cdec |
|
BLAKE2b-256 | 71da29cb9f3ab1502c71d7d6bdab85d05401ea3c0f51464fba37fa905be1ea2e |