author | Olivier Brunel
<jjk@jjacky.com> 2023-07-08 20:06:54 UTC |
committer | Olivier Brunel
<jjk@jjacky.com> 2023-07-10 09:31:21 UTC |
parent | c7a38cb49bf33d250c040b11f8c59bdb1cea3d0c |
meta/desc | +3 | -3 |
diff --git a/meta/desc b/meta/desc index 5078604..5ab4af0 100644 --- a/meta/desc +++ b/meta/desc @@ -4,7 +4,7 @@ Quick MarkDown Documentation Generator 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 can made available and shared. +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. @@ -19,10 +19,10 @@ For example, the way to set emphasis and other style has been adjusted : 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 and simply notes. +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 1 to 8. Such links will be automatically made to +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.