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
Use the source directory as a positional argument:
madoc .
You can combine options and source path:
madoc -t "My title" .
You can also choose where the generated html is written with -o/--output
(path is relative to where you launch the command):
madoc test_files -o out
madoc -t "My title" test_files -o ./dist
If no source directory is provided, Madoc uses the current directory:
madoc
done, you have your documentation in a single html file in the source directory.
If -o is provided, the html file is written in the output directory instead.
Know more options with madoc -h.
Bookbinding usage
You can aggregate multiple existing html pages into a single portal page with:
madoc-bookbinding
Short alias:
madoc-bb
Examples:
madoc-bb -p some.html -i icon.png -p another.html --output .
madoc-bookbinding -p first.html -p second.html -o ./dist
Notes:
-padds a page.-isets the icon of the previous-p.- default mode embeds pages/icons as base64.
--no-b64keeps file links/URLs.--get-templatecopies the default bookbinding template locally.
Changelog
- 1.5.0: css overload ability
- 1.4.0: Bookdinding
- 1.3.0: customizing a template is possible
- 1.2.6: converts download links to base64 (optionnal)
- 1.2.5: responsive design improved, possibility to prefix the files with '(XXX..)' to sort the files without appearing in the displayed names
- 1.2.0: reworked without any JS dependencies (=readable offline), prettier template, base64 images conversion !
- to be deprecated: the recursive option, will be replaced by something else (WIP...)
- 1.1.1: responsive design
- 1.1.0: Recursive build mode
Libraries used by Madoc
JS (used in recursive mode only)
- Bulma (CSS framework)
- Vue.js (JS framework)
- Marked (JS library)
Python (already included in the pip setup)
- Jinja2 (python library)
- markdown
- Pygments
- requests
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file madoc-1.5.0.tar.gz.
File metadata
- Download URL: madoc-1.5.0.tar.gz
- Upload date:
- Size: 40.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c93f0695513ec63ccc7832781a90c3edabe944e379e8c4df2434aa474ac139bd
|
|
| MD5 |
2222f91b9b66a4d7712263372799ebc6
|
|
| BLAKE2b-256 |
f3f60b2de9e072ab40daabc8c680db43b1feb447853b979833dd0d39bf9c40a6
|
File details
Details for the file madoc-1.5.0-py3-none-any.whl.
File metadata
- Download URL: madoc-1.5.0-py3-none-any.whl
- Upload date:
- Size: 39.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6948db954cbe9235c6b2b8aa2a76c83f15926d1851f10eee9b35cd2f6155446b
|
|
| MD5 |
1d5f5e276880d38a1350f85902801069
|
|
| BLAKE2b-256 |
cfbaa36609e361eed88895552aa6536f17750026c0aadb29e3cedb785c3ead78
|
