docs.txt (1042B) download
1The Documentation markup (in src/docs, src/man) isn't just Markdown or whatever but
2an own language which is intended to be parsed really easy, don't expect a lot, it's just
3some ' '-splitting and regex-replacing.
4In this document I want to present the syntax.
5
6Conversion is done with the scripts make-docs.py for html and make-man.py for obviously man
7
8Blocks and Titles
9=================
10
11@header <text...>
12
13Prints the header with <text> as header-text, followed by 'shut the lights off'-button and github-link.
14It's ignored if converted to man.
15
16@man <manual> <section> <date> <version> <manual-title>
17
18Prints the manual-header.
19It's ignored if converted to html.
20
21@title <id> <text...>
22
23Prints a (section) title, <id> is used for click-to-section.
24<id> is ignored by man.
25
26@list
27...
28@endlist
29
30Make a list delimited by empty lines.
31
32@code
33...
34@endcode
35
36Make an code-block, ignored by man.
37
38
39Inline Markup
40=============
41
42*bold*
43_italic_
44[text](http://link.com) | ignored by man
45text~ | prints a newline, without interpreting something else