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
Metadata
1 maintainer
Release files for madoc 1.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| madoc-1.5.0.tar.gz | 40.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| madoc-1.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 79.0 kB
Release files / madoc-1.5.0.tar.gz
| Download URL | madoc-1.5.0.tar.gz |
|---|---|
| Size | 40.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c93f0695513ec63ccc7832781a90c3edabe944e379e8c4df2434aa474ac139bd
|
|
BLAKE2b-256 checksum How to use checksums |
f3f60b2de9e072ab40daabc8c680db43b1feb447853b979833dd0d39bf9c40a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
Release files / madoc-1.5.0-py3-none-any.whl
| Download URL | madoc-1.5.0-py3-none-any.whl |
|---|---|
| Size | 39.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6948db954cbe9235c6b2b8aa2a76c83f15926d1851f10eee9b35cd2f6155446b
|
|
BLAKE2b-256 checksum How to use checksums |
cfbaa36609e361eed88895552aa6536f17750026c0aadb29e3cedb785c3ead78
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
