Welcome to little lamb

Code » qmdoc » master » tree

[master] / meta / desc

Quick MarkDown Documentation Generator

*qmdoc* is a simple, lightweight, fast tool that will convert MarkDown files
into HTML files, with an aim at documentation.

The generated files are pure HTML/CSS, without any JavaScript. Thus they are
static files that can easily be made available and shared.

Relying on the [md4c] parser, it is mostly CommonMark compliant - /mostly/,
because it comes with a few (unique) extensions to easy things up.

For example, the way to set emphasis and other style has been adjusted :

* Text in between stars (e.g. `*foobar*`) will be *bold*
* Text in between slashes (e.g. `/foobar/`) will be /italic/
* Text in between underscores (e.g. `_foobar_`) will be _underlined_
* Text in between tildes (e.g. `~foobar~`) will be ~striked~
* Text in between equal signs (e.g. `=foobar=`) will be =highlighted=

As expected *qmdoc* supports code blocks, quote blocks, lists, etc as well as
indentation blocks (usefull to write man page-like document) and so-called
boxes to present warnings, information, hints or simply notes.

It also supports "/man-page links/" - that is links of the form `[foobar](n)`
where `n` is a digit from 0 to 9. Such links will be automatically made to
target a matching page (e.g. `foobar.n.html`) being generated if any, else can
be linked using a specified prefix URL, or simply not made into link.  Either
way, the text will be in the form `foobar(n)` as you'd expect.

*qmdoc* will also generate a Table of Contents for each generated pages, as well
as a global TOC encompassing all generated pages, thusly creating an overall
(customizable) index.html providing the user with the full documentation's TOC.


[md4c]: https://github.com/mity/md4c