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.11.tar.gz
(18.6 kB
view details)
Built Distribution
madoc-1.1.11-py3-none-any.whl
(23.6 kB
view details)
File details
Details for the file madoc-1.1.11.tar.gz.
File metadata
- Download URL: madoc-1.1.11.tar.gz
- Upload date:
- Size: 18.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5854f6e510bb6fdc4becd0ce89e2d650fa1c985adad2862f4e48186ad4b7ce53 |
|
| MD5 | fb1d0ba8b3a7cd67501fb02aecd8c6fa |
|
| BLAKE2b-256 | 591dcec91468b7ffe82c6f1bee708fae146670f33ef2b3eb89a079100d6e4d5d |
File details
Details for the file madoc-1.1.11-py3-none-any.whl.
File metadata
- Download URL: madoc-1.1.11-py3-none-any.whl
- Upload date:
- Size: 23.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ee200d213e761e970a99d9bb9cfe4628f56bd4e7744257f56e848d5e30845269 |
|
| MD5 | 7e73b719e2605e2589e931e3a1d4080d |
|
| BLAKE2b-256 | fcf8fdb3c63cc1eb82a5d6f75fd42004fd664881771b545c13d81abe7487fe70 |
