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.
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-0.0.1.tar.gz
(4.6 kB
view details)
Built Distribution
madoc-0.0.1-py3-none-any.whl
(5.0 kB
view details)
File details
Details for the file madoc-0.0.1.tar.gz.
File metadata
- Download URL: madoc-0.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 | 1b541328dbf2b69a2c61a709eb2fb895f9002da238d053617bbd2fd6cc53be2e |
|
| MD5 | 0c907ad43f52706b7da49de934dba113 |
|
| BLAKE2b-256 | 585bd088aa6d917ce3bd71a7e1adcc4c65100b5446c247c26da5e97eb889ffd7 |
File details
Details for the file madoc-0.0.1-py3-none-any.whl.
File metadata
- Download URL: madoc-0.0.1-py3-none-any.whl
- Upload date:
- Size: 5.0 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 | 92bf47f2a6c8efa21ac00f5a5c391f242af31bfa96a5441d0ff8db43aba63c37 |
|
| MD5 | 00311d1f4f0da81fd17f3e43a44d06a0 |
|
| BLAKE2b-256 | 5bf5ac37181994f04c051e3aa306fcdbdb9c7a26a7cbac2443c6a86bb4afba8b |
