-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.html
248 lines (161 loc) · 6.73 KB
/
README.html
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<h1>Markaround</h1>
<p>Markaround is a shorthand replacement for the most commonly used subset of HTML for writing on the web.</p>
<p>Writing in Markaround is half way between using a WYSIWYG editor and hand-coding HTML.</p>
<p>The problem with WYSIWYG editors is not so much that you cannot control the HTML it generates as the HTML mess it creates. Markaround's syntax can be unambiguously and unsurprisingly converted to HTML so you always know what HTML will be generated. It's not the same as hand-coding HTML, but it's good enough most of the time.</p>
<h2>Syntax</h2>
<h3>Inline Markup</h3>
<h4>Strong (bold)</h4>
<p>Enclose words in asterisk to make them <strong>strong</strong>.</p>
<p>Markdown: <code>Enclose words in asterisk to make them *strong*.</code><br />
HTML: <code><p>Enclose words in asterisk to make them <strong>strong</strong>.</p></code></p>
<h4>Emphasis (italics)</h4>
<p>Enclose words in underscore to <em>emphasize</em> them.</p>
<p>Markdown: <code>Enclose words in underscore to _emphasize_ them.</code><br />
HTML: <code><p>Enclose words in underscore to <em>emphasize</em> them.</p></code></p>
<h4>Delete (strikethrough)</h4>
<p>Enclose words in hypen to mark them as <del>deleted</del>.</p>
<p>Markdown: <code>Enclose words in hypen to mark them as -deleted-.</code><br />
HTML: <code><p>Enclose words in hypen to mark them as <del>deleted</del>.</p></code></p>
<h4>Code Span (monospace)</h4>
<p>Enclose words in two single quotes to make them <code>monospaced</code>.</p>
<p>Markdown: <code>Enclose words in two single quotes to make them ''monospaced''.</code><br />
HTML: <code><p>Enclose words in two single quotes to make them <code>monospaced</code>.</p></code></p>
<p>Two single quotes are also used for code block. See Code Blocks section below.</p>
<h3>Block Markup</h3>
<h4>Paragraphs and Line Breaks</h4>
<p>This is a paragraph. It requires no special markup.</p>
<p>This is another paragraph. You can separate two consecutive paragraphs with a blank line.</p>
<ul><li>Other block-level elements also end paragraphs.</li></ul>
<p>Newlines within paragraphs<br />
are treated as line breaks. To stop this from happening,
precede the newline with a backslash.</p>
<p>Markdown:</p>
<pre><code>
This is a paragraph. It requires no special markup.
This is another paragraph. You can separate two consecutive paragraphs with a blank line.
* Other block-level elements also end paragraphs.
Newlines within paragraphs
are treated as line breaks. To stop this from happening \
precede the newline with a backslash.
</code></pre>
<p>HTML</p>
<pre><code>
<p>This is a paragraph. It requires no special markup.</p>
<p>This is another paragraph. You can separate two consecutive paragraphs with a blank line.</p>
<ul><li><p>Other block-level elements also end paragraphs.</p></li></ul>
<p>Newlines within paragraphs<br />
are treated as line breaks. To stop this from happening,
precede the newline with a backslash.</p>
</code></pre>
<h4>Headers</h4>
<h1>Level 1</h1>
<h2>Level 2</h2>
<h3>Level 3</h3>
<h4>Level 4</h4>
<h5>Level 5</h5>
<h6>Level 6</h6>
<p>Markaround:</p>
<pre><code>
= Level 1
== Level 2
=== Level 3
==== Level 4
===== Level 5
====== Level 6
</code></pre>
<p>HTML:</p>
<pre><code>
<h1 id="level_1">Level 1</h1>
<h2 id="level_2">Level 2</h2>
<h3 id="level_3">Level 3</h3>
<h4 id="level_4">Level 4</h4>
<h5 id="level_5">Level 5</h5>
<h6 id="level_6">Level 6</h6>
</code></pre>
<h4>Horizontal Rule</h4>
<p>A line with one or more hyphens by themselves is converted to <code><hr /></code>. Like so:</p>
<hr />
<p>Markaround:</p>
<pre><code>
A line with one or more hyphens by themselves is converted to ''<hr />''. Like so:
------
</code></pre>
<p>HTML:</p>
<pre><code>
<p>A line with one or more hyphens by themselves is converted to <code>&lt;hr /&gt;</code>. Like so:</p>
<hr />
</code></pre>
<h4>Code Blocks</h4>
<p>Two single quotes on a line by themselves marks the start and end of a clode block. If they are indented, then every line in the contained text is stripped of the same number of spaces and/or tabs.</p>
<p>Here is some code:</p>
<pre><code>
<?php
echo "Hello World";
?>
</code></pre>
<p>Markaround:</p>
<pre><code>
Two single quotes on a line by themselves marks the start and end of a clode block. If they are indented, then every line in the contained text is stripped of the same number of spaces and/or tabs.
Here is some code:
''
<?php
echo "Hello World";
?>
''
</code></pre>
<p>HTML:</p>
<pre><code>
<p>Two single quotes on a line by themselves marks the start and end of a clode block. If they are indented, then every line in the contained text is stripped of the same number of spaces and/or tabs.</p>
<p>Here is some code:</p>
<pre><code>
&lt;?php
echo &quot;Hello World&quot;;
?&gt;
</code></pre>
</code></pre>
<h3>Blockquotes</h3>
<blockquote><p>This is a blockquote with two paragraphs.</p>
<p>This is the second paragraph.<br />
Newline escape
works here as well.</p></blockquote>
<blockquote><p>You can separate two consecutive blockquotes with a blank line.</p></blockquote>
<ul><li>Other block-level elements also end paragraphs.</li></ul>
<blockquote><p>Blockquotes can also contain other block level elements.</p>
<h1>Header</h1>
<ul><li>one</li>
<li>two</li>
<li>three</li></ul>
<blockquote><p>This is a blockquote in a blockquote.</p></blockquote>
<pre><code>
This is a code block
</code></pre>
</blockquote>
<p>Markaround:</p>
<pre><code>
</code></pre>
<p>HTML:</p>
<pre><code>
</code></pre>
<h3>Lists</h3>
<ul><li>List items start with a list marker followed by a space.</li>
<li>Unordered list items start with an asterisk and ordered list items start with a hash.</li></ul>
<ul><li>A blank line or another block element will end a list.</li>
<li><p>Lists can also contain other block level elements including other lists.</p>
<p>Just connect all the lines of a list item by starting them with a pipe character folowed by a space, aka the list continuation marker.</p>
<h1>Header</h1>
<ol><li>one</li>
<li>two</li>
<li>three</li></ol>
<blockquote><p>This is a blockquote.</p></blockquote>
<pre><code>
This is a code block
</code></pre>
</li>
<li><p>To wrap list item contents in a <p> tag, leave a blank line after the list item like so</p>
</li></ul>
<p>Markaround:</p>
<pre><code>
</code></pre>
<p>HTML:</p>
<pre><code>
</code></pre>