-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathMarkdown Guide (HTML).html
334 lines (292 loc) · 9.72 KB
/
Markdown Guide (HTML).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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<h1>Markdown Cheatsheet</h1>
<p>This cheatsheet is intended as a quick reference and showcase of the markdown syntax in <strong>GROOT</strong></p>
<hr />
<h2>Headers</h2>
<pre><code class="markdown"># H1
## H2
### H3
#### H4
##### H5
###### H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
======
Alt-H2
------
</code></pre>
<h1>H1</h1>
<h2>H2</h2>
<h3>H3</h3>
<h4>H4</h4>
<h5>H5</h5>
<h6>H6</h6>
<p>Alternatively, for H1 and H2, an underline-ish style:</p>
<h1>Alt-H1</h1>
<h2>Alt-H2</h2>
<hr />
<h2>Emphasis</h2>
<pre><code class="markdown">Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
</code></pre>
<p>Emphasis, aka italics, with <em>asterisks</em> or <em>underscores</em>.</p>
<p>Strong emphasis, aka bold, with <strong>asterisks</strong> or <strong>underscores</strong>.</p>
<p>Combined emphasis with <strong>asterisks and <em>underscores</em></strong>.</p>
<hr />
<h2>Lists</h2>
<p>(In this example, leading and trailing spaces are shown with with dots: ⋅)</p>
<pre><code class="markdown">1. First ordered list item
2. Another item
⋅⋅⋅⋅* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
⋅⋅⋅⋅1. Ordered sub-list
4. And another item.
⋅⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
⋅⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
⋅⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅
* Unordered list can use asterisks
- Or minuses
+ Or plusesd
</code></pre>
<ol>
<li>First ordered list item</li>
<li>Another item<ul>
<li>Unordered sub-list. </li>
</ul>
</li>
<li>Actual numbers don't matter, just that it's a number<ol>
<li>Ordered sub-list</li>
</ol>
</li>
<li>
<p>And another item.</p>
<p>You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces.</p>
<p>To have a line break without a paragraph, you will need to use two trailing spaces.<br />
Note that this line is separate, but within the same paragraph. </p>
</li>
</ol>
<ul>
<li>Unordered list can use asterisks</li>
<li>Or minuses</li>
<li>Or pluses</li>
</ul>
<hr />
<h2>Links</h2>
<p>There are two ways to create links.</p>
<pre><code class="markdown">[I'm an inline-style link](https://www.duckduckgo.com)
[I'm an inline-style link with title](https://www.duckduckgo.com "DuckDuckGo's Homepage")
[You can use numbers for reference-style link definitions][1]
URLs in angle brackets will automatically get turned into links in the preview.
<https://privacytools.io>
</code></pre>
<p><a href="https://www.duckduckgo.com">I'm an inline-style link</a></p>
<p><a href="https://www.duckduckgo.com" title="DuckDuckGo's Homepage">I'm an inline-style link with title</a></p>
<p>URLs in angle brackets will automatically get turned into links in the preview. <br />
<a href="https://www.privacytools.io">https://www.privacytools.io</a></p>
<p>If the "Automatically Detect Links Extension" is checked, URLs without angular brackets will also be detected</p>
<hr />
<h2>Inline code and code blocks</h2>
<pre><code class="markdown">Inline `code` has `back-ticks around` it.
</code></pre>
<p>Inline <code>code</code> has <code>back-ticks around</code> it.</p>
<p>Blocks of code are either fenced by lines with three back-ticks, or are indented with four spaces.</p>
<pre><code class="markdown"> s = "Code with space indent"
print s
</code></pre>
<pre><code>s = "Code with space indent"
print s
</code></pre>
<hr />
<h2>Tables</h2>
<p>Tables aren't part of the core Markdown spec, but the QOwnNotes preview supports them. </p>
<pre><code class="markdown">Colons can be used to align columns.
| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
There must be at least 3 dashes separating each header cell.
The outer pipes (|) are optional, and you don't need to make the
raw Markdown line up prettily. You can also use inline Markdown.
Markdown | Less | Pretty
--- | --- | ---
*Still* | `renders` | **nicely**
1 | 2 | 3
</code></pre>
<p>Colons can be used to align columns.</p>
<table>
<thead>
<tr>
<th>Tables</th>
<th align="center">Are</th>
<th align="right">Cool</th>
</tr>
</thead>
<tbody>
<tr>
<td>col 3 is</td>
<td align="center">right-aligned</td>
<td align="right">$1600</td>
</tr>
<tr>
<td>col 2 is</td>
<td align="center">centered</td>
<td align="right">$12</td>
</tr>
<tr>
<td>zebra stripes</td>
<td align="center">are neat</td>
<td align="right">$1</td>
</tr>
</tbody>
</table>
<p>There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.</p>
<table>
<thead>
<tr>
<th align="center">Markdown</th>
<th align="center">Less</th>
<th align="center">Pretty</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center"><em>Still</em></td>
<td align="center"><code>renders</code></td>
<td align="center"><strong>nicely</strong></td>
</tr>
<tr>
<td align="center">1</td>
<td align="center">2</td>
<td align="center">3</td>
</tr>
</tbody>
</table>
<hr />
<h2>Blockquotes</h2>
<pre><code class="markdown">> Blockquotes are very handy in email to emulate reply text.
> This line is part of the same quote.
Quote break.
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
</code></pre>
<blockquote>
<p>Blockquotes are very handy in email to emulate reply text.<br />
This line is part of the same quote.</p>
</blockquote>
<p>Quote break.</p>
<blockquote>
<p>This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can <em>put</em> <strong>Markdown</strong> into a blockquote. </p>
</blockquote>
<hr />
<h2>Horizontal Rule</h2>
<pre><code class="markdown">Three or more...
---
Hyphens
***
Asterisks
___
Underscores
</code></pre>
<p>Three or more...</p>
<hr />
<p>Hyphens</p>
<hr />
<p>Asterisks</p>
<hr />
<p>Underscores</p>
<hr />
<h2>Line Breaks</h2>
<pre><code class="markdown">Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
This line is also begins a separate paragraph, but...
This line is only separated by two trailing spaces and a single newline, so it's a separate line in the *same paragraph*.
</code></pre>
<p>Here's a line for us to start with.</p>
<p>This line is separated from the one above by two newlines, so it will be a <em>separate paragraph</em>.</p>
<p>This line is also begins a separate paragraph, but...<br />
This line is only separated by two trailing spaces and a single newline, so it's a separate line in the <em>same paragraph</em>.</p>
<hr />
<h2>Comments</h2>
<pre><code class="markdown">[comment]: # (This comment will not appear in the preview)
</code></pre>
<hr />
<p>Credit for the above cheatsheet: <a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet">markdown-here</a><br />
License: <a href="https://creativecommons.org/licenses/by/3.0/">CC-BY</a></p>
<h2>Extensions</h2>
<ul>
<li>files can be inserted (images are displayed) in markdown using the insert image button</li>
<li>notes can be encrypted and decrypted using the <strong>"lock buttons"</strong> for additional security</li>
<li>current date/time can be added using the <strong>"clock button"</strong></li>
</ul>
<hr />
<h3>Plugins</h3>
<ul>
<li>
<p><strong>Enable Hard Breaks</strong></p>
<p><code>When enabled, the lines are changed with single new lines</code></p>
</li>
<li>
<p><strong>Enable Footnotes</strong></p>
<p><em>Example -</em></p>
</li>
</ul>
<pre><code>Footnotes[^1] have a label[^@#$%] and the footnote's content.
[^1]: This is a footnote content.
[^@#$%]: A footnote on the label: "@#$%".
</code></pre>
<ul>
<li><strong>Enable Definition Lists</strong></li>
</ul>
<pre><code class="markdown">Apple
: Pomaceous fruit of plants of the genus Malus in
the family Rosaceae.
Orange
: The fruit of an evergreen tree of the genus Citrus.
</code></pre>
<dl>
<dt>Apple</dt>
<dd>Pomaceous fruit of plants of the genus Malus in<br />
the family Rosaceae. </dd>
<dt>Orange</dt>
<dd>The fruit of an evergreen tree of the genus Citrus.</dd>
</dl>
<ul>
<li><strong>Enable Markdown in HTML</strong></li>
</ul>
<pre><code>This is *true* markdown text.
<div markdown="1">
This is *true* markdown text.
</div>
</code></pre>
<ul>
<li>
<p><strong>Enable Superscript</strong></p>
<p><code>x^y^</code> = x<sup>y</sup></p>
</li>
<li>
<p><strong>Enable Subscript</strong></p>
<p><code>H~2~O</code> = H<sub>2</sub>O</p>
</li>
<li>
<p><strong>Enable Auto Detect Links</strong></p>
<p><a href="https://www.duckduckgo.com/">https://www.duckduckgo.com/</a></p>
</li>
<li>
<p><strong>Enable Smart Symbols</strong></p>
<p><code>(tm)</code> = ™<br />
<code>(c)</code> = ©<br />
<code>(r)</code> = ®<br />
<code>(c)</code> = ℅<br />
<code>+/-</code> = ±<br />
<code>--></code> = →<br />
<code><--</code> = ←<br />
<code><--></code> = ↔<br />
<code>=/=</code> = ≠<br />
<code>1/4</code> = ¼<br />
<code>1st 2nd</code> = 1<sup>st</sup> 2<sup>nd</sup></p>
</li>
<li>
<p><strong>Enable Strike</strong></p>
<p><code>~~striked text~~</code> = <s>striked text</s></p>
</li>
</ul>