tttml.5 - tttml - converters for a simpler syntax than markdown
HTML git clone git://bitreich.org/tttml git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/tttml
DIR Log
DIR Files
DIR Refs
DIR Tags
DIR README
---
tttml.5 (2461B)
---
1 .Dd $Mdocdate: April 19 2018$
2 .Dt TTTML 5
3 .Os
4 .
5 .
6 .Sh NAME
7 .
8 .Nm tttml
9 .Nd simpler markup syntax than markdown
10 .
11 .
12 .Sh SYNOPSIS
13 .
14 .Pa file.md
15 .
16 .
17 .Sh DESCRIPTION
18 .
19 The
20 .Nm
21 format is a very simple format for writiing text that look good
22 enough to be published without conversion.
23 It lacks the markdown recursive syntax
24 .Pq such as recursive lists anb quotes
25 which also remove markdown ambiguities.
26 .
27 Each block of text is separated from anotherone by an empty line.
28 .
29 .Bl -tag -width 6n
30 .
31 .It paragraph
32 Any non-special block of text:
33 .
34 .Bd -literal -offset 3n
35 First paragraph of text.
36
37 Second paragraph of text.
38 .Ed
39 .
40 .It title
41 Block that ends by a line with only
42 .Sq Li = :
43 .
44 .Bd -literal -offset 3n
45 Title can therefore have multiple lines if required
46 although it is not advised.
47 ======================================================
48 .Ed
49 .
50 .It heading
51 Block that ends with a line with only
52 .Sq Li - :
53 .
54 .Bd -literal -offset 3n
55 Heading can also have multiple lines
56 ------------------------------------------------------
57 .Ed
58 .
59 .It subheading
60 Block with a single line with at least 3 leading
61 .Sq Li #
62 characters starting at subheading and going down the outline
63 .Pq subheading, subsubheading ...
64 every time an additionnal
65 .Sq Li #
66 is added:
67 .
68 .Bd -literal -offset 3n
69 ### Subheading
70
71 #### Subsubheading
72
73 ##### Subsubsubheading
74 .Ed
75 .
76 .It tag
77 Block that start with a tag line:
78 .
79 .Bd -literal -offset 3n
80 *tagline with asterisks and a column*:
81 Body of the tag block that can span over multiple
82 lines like regular paragraphs.
83 .Ed
84 .
85 .It list
86 Block that start with a dash:
87 .Bd -literal -offset 3n
88 - List item. The following lines might not have
89 leading space.
90
91 - Note that multi-paragraph lists are not handled
92 .Ed
93 .
94 .It quote
95 Block that has a leading
96 .Sq Li >
97 on every line:
98 .
99 .Bd -literal -offset 3n
100 > Mail-style quoting. Note that nested quotes
101 > are not handled.
102 .Ed
103 .
104 .It literal
105 Block that has a leading tab on every line:
106 .
107 .Bd -literal -offset 3n
108 Nothing gets interpreted in these blocks.
109 They get printed as-is.
110 They may contain extra tabs.
111 .Ed
112 .
113 .It link
114 Block that start with a label line and eventual subsequent description
115 lines:
116 .
117 .Bd -literal -offset 3n
118 [label]: git://josuah.net/git/tttml
119 git repository for the tttml set of tools
120
121 [label2]: /url/without/description.txt
122 .Ed
123 .
124 .El
125 .
126 .
127 .Sh SEE ALSO
128 .Xr smu 1 ,
129 .Lk https://github.com/Gottox/smu "simple markup - markdown like syntax"
130 .
131 .
132 .Sh AUTHORS
133 .
134 .An Josuah Demangeon
135 .
136 .Aq Mt mail@josuah.net