1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
Em is a limited hypertext markup language.
It is similar to Markdown, but it has a few key advantages:
1. It is more readable.
2. It is simpler to parse.
3. There is *not* more than one way to do it (forgive me, Larry).
Em takes plain-text readability seriously. You should be able to
write em in a plain-text e-mail message without the recipient noticing.
On the other hand, that means that it is limited in terms of what HTML
it can produce. Most noticeably, only a very limited form of inline links
are supported (see *Lists* and *Inline formatting*).
For examples, see the source code for this text [a] or the test file [b].
[a] ../tree/README
[b] ../tree/test.em
Em is implemented in portable awk, with an rc script to bind it together.
The rc script can (more or less) trivially be translated to POSIX shell,
but the work has not been done yet.
Em's complete and exact syntax is defined by its implementation [c],
but a general description follows below.
[c] ../tree/emparse
---
== Inline formatting ==
---
=== Font style ===
Italic, bold and teletype text is marked with the asterisk,
the underscore and the backtick, respectively:
Example of *italic text*, _bold text_ and `teletype text`.
The marks are only valid in certain positions:
1. At word borders
2. At the beginning of a word after an opening parenthesis
3. At the end of a word before any of `.,:;?!)`
4. At the end of a word before a closing parenthesis followed by any of `.,:;?!`
---
=== Inline references ===
Inline references are created with square brackets:
Example of an inline reference [1].
[1] The quick brown fox ...
For more information about references, see *Reference lists* below.
---
=== Hyperlinks ===
Hyperlinks are a special case of inline references. When an inline
reference refers to a reference containing only a web address,
the inline reference is replaced with a hyperlink to that address.
It is available for download [a].
[a] v1.tgz
The above example translates to the following HTML:
<p>It is available for download (<a href="v1.tgz">link</a>).
</p>
The default link text ("link") can be changed by setting
the `linktext` environment variable.
---
== Block-level formatting ==
- _A single empty line marks a block break._ There is
no exception to this rule. The line is removed in the final output.
- All blocks support inline formatting, except headings,
preformatted blocks and terms in definition lists.
- One block cannot be put within another block. For example,
it is impossible to put a paragraph or a preformatted block
inside a list item.
---
=== Headings ===
Headings begin and end with the same number of equal signs:
= First-level heading =
== Second-level heading ==
---
=== Lists ===
_All lists start with a single space_, followed by some marker.
_Unordered lists_ are created with `- `:
- This is an unordered list
- With two items
_Ordered lists_ are created with `n. `:
1. This is an ordered list
2. With an item that spans
two lines
_Definition lists_ are created with `term: `:
dinosaur: an animal
_Reference lists_ are created with `[n] `:
[1] This is a reference list
[2] With two items
==== Nesting ====
Unordered and ordered lists can be nested. _An additional space_
at the beginning of the line increases the item level by one:
1. First level
- Second level
2. First level
==== Reference lists ====
A reference list is a special type of list. It is a type of footnote list,
to which you can make inline references:
See footnote [1].
[1] The quick brown fox ...
_Note:_ There is a special type of reference list item called a
*hyperlink reference*. It contains only a single word,
without whitespace:
[1] http://example.com
Hyperlink reference items are removed in the final output,
but you can still reference them inline:
You can download the file here [1].
---
=== Preformatted blocks ===
_Preformatted blocks start with a single tab:_
#include <stdio.h>
main() { puts("Hello world!\n"); }
---
=== Paragraphs ===
_Paragraphs start with no space:_
This is a paragraph
with two lines.
This is another paragraph.
|