https://github.com/byoso/madoc
Creates a clean documentation from your markdown files.
https://github.com/byoso/madoc
markdown markdown-to-html python3
Last synced: about 2 months ago
JSON representation
Creates a clean documentation from your markdown files.
- Host: GitHub
- URL: https://github.com/byoso/madoc
- Owner: byoso
- License: mit
- Created: 2023-09-20T18:41:19.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T21:12:14.000Z (3 months ago)
- Last Synced: 2025-05-01T05:17:17.271Z (about 2 months ago)
- Topics: markdown, markdown-to-html, python3
- Language: HTML
- Homepage:
- Size: 65.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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
```console
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.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