Documentation generator from markdown files
Project description
Madoc
What is Madoc 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 the .md files are, and just type:
madoc
done, you have your documentation in a single html file.
Know more options with madoc -h.
Changelog
- 1.1.1: responsive design
- 1.1.0: Recursive build mode
Libraries used by Madoc
- Bulma (CSS framework)
- Vue.js (JS framework)
- Marked (JS library)
- Jinja2 (python library)
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.1.10.tar.gz
(18.6 kB
view details)
Built Distribution
madoc-1.1.10-py3-none-any.whl
(23.6 kB
view details)
File details
Details for the file madoc-1.1.10.tar.gz.
File metadata
- Download URL: madoc-1.1.10.tar.gz
- Upload date:
- Size: 18.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 | 7731e04e22eb128f516d1632af9f24c3a7a70a9375bf302b376aa9bd3d33c401 |
|
| MD5 | eade59ff29d6d9f6e23f8d7b541169e7 |
|
| BLAKE2b-256 | a4e784b177e5ed1c56d228c362dfa99cba1ca2800f5284ee47d2b7290a2bc8bb |
File details
Details for the file madoc-1.1.10-py3-none-any.whl.
File metadata
- Download URL: madoc-1.1.10-py3-none-any.whl
- Upload date:
- Size: 23.6 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 | deb01a42c4af40773f6fc682636530c5e76da480ece2fd9e5f60690f4b938ff7 |
|
| MD5 | 5527c866c5db482d0066d00b2813d1c1 |
|
| BLAKE2b-256 | 2b9bdb2aa9e3a3c4cf058cfcb0a7b7bd65d7ab959c91730c652ac8a74ae65520 |
