Skip to main content

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)

Project details


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.10.tar.gz (18.6 kB view hashes)

Uploaded Source

Built Distribution

madoc-1.1.10-py3-none-any.whl (23.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page