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.12.tar.gz
(18.8 kB
view details)
Built Distribution
madoc-1.1.12-py3-none-any.whl
(23.7 kB
view details)
File details
Details for the file madoc-1.1.12.tar.gz.
File metadata
- Download URL: madoc-1.1.12.tar.gz
- Upload date:
- Size: 18.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1013f8ca15445d96f59550ee108cd934ab61d39cb90597c42935b6ec9bf9a061 |
|
| MD5 | d857ee7a542743856c485b16d47debff |
|
| BLAKE2b-256 | e26fd82ffa11329d452ff649fb0abcac94479d98ec22691b813ecf18f38284ad |
File details
Details for the file madoc-1.1.12-py3-none-any.whl.
File metadata
- Download URL: madoc-1.1.12-py3-none-any.whl
- Upload date:
- Size: 23.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8cf4fd159c9a35d1585789fe167574d8d1519ce8f6e434aedd9c2671e88dcbc5 |
|
| MD5 | f3387c88df208511283e39a5107710f6 |
|
| BLAKE2b-256 | cd96fdaa562ae6e3cc784cbd749e286e07a1084b83228866e35cb6713a4ec2de |
