forked from edouard/human-markdown-reference
/
MMD-Guide.html
executable file
·666 lines (528 loc) · 19.2 KB
/
MMD-Guide.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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>MultiMarkdown Guide</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name = "viewport" content = "width = device-width">
<meta name = "viewport" content = "initial-scale = 1.0">
<link rel="stylesheet" type="text/css" media="screen" href="markdown-reference.css" />
<script type="text/javascript" src="javascripts/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="javascripts/guide.js"></script>
</head>
<body>
<h1 id="title">MultiMarkdown Guide</h1>
<h2 class="section-name">Text</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>This text is **bold**.</td>
<td>This text is <strong>bold</strong>.</td>
</tr>
<tr>
<td>This text is also __bold__.</td>
<td>This text is also <strong>bold</strong>.</td>
</tr>
<tr>
<td>This text is *italicized*.</td>
<td>This text is <em>italicized</em>.</td>
</tr>
<tr>
<td>This text is also _italicized_.</td>
<td>This text is also <em>italicized</em>.</td>
</tr>
<tr>
<td>`This is some code.`</td>
<td><code>This is some code.</code></td>
</tr>
<tr>
<td> This is a rather<br />
long section of code<br/>
taking multiple lines</td>
<td><code>This is a rather<br />
long section of code<br />
taking multiple lines</code></td>
</tr>
</table>
</div>
<h2 class="section-name">Links</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Link to [Google](http://google.com).</td>
<td>Link to <a href="http://google.com">Google</a>.</td>
</tr>
<tr>
<td>Link to <http://google.com>.</td>
<td>Link to <a href="http://google.com">http://google.com</a>.</td>
</tr>
<tr>
<td>Link to [Google][] with attributes later in the document.<br />
<br />
Another Link to the [search engine][Google].<br /><br />
[Google]: http://google.com "The Google!" style="border: solid black 1px;" target="_blank"</td>
<td>
<p>Link to <a href="http://google.com" title="The Google!" style="border: solid black 1px;" target="_blank">Google</a> with attributes later in the document.</p>
<p>Another link to the <a href="http://google.com" title="The Google!" style="border: solid black 1px;" target="_blank">search engine</a>.</p>
</td>
</tr>
<tr>
<td>Send me an email at <address@example.com>.</td>
<td>Send me an email at <a href="mailto:address@example.com">address@example.com</a>.</td>
</tr>
</table>
</div>
<h2 class="section-name">Headings</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td># First Header</td>
<td><h1>First Header</h1></td>
</tr>
<tr>
<td>## Second Header ##</td>
<td><h2>Second Header</h2></td>
</tr>
<tr>
<td>### Third Header</td>
<td><h3>Third Header</h3></td>
</tr>
</table>
</div>
<h2 class="section-name">Blockquotes</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Here is the a normal paragraph.<br />
<br />
> This is the first level of quoting.<br />
<br />
>> This is nested blockquote<br />
that runs onto the next line.<br />
<br />
> Back to the first level.<br />
<br />
Notice the spaces when we start a new paragraph or separate the different blockquotes.</td>
<td>
<p>Here is the a normal paragraph.</p>
<blockquote>
<p>This is the first level of quoting.</p>
<blockquote>
<p>This is nested blockquote that runs onto the next line.</p>
</blockquote>
<p>Back to the first level.</p>
</blockquote>
<p>Notice the spaces when we start a new paragraph or separate the different blockquotes.</p>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Images and Figures</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>This is the simplest example of an  embedded in a paragraph.</td>
<td>This is the simplest example of an <img src="app_icon.png" alt="MultiMarkdown Composer Icon" /> embedded in a paragraph.</td>
</tr>
<tr>
<td>This is an image example with a title attribute  embedded in a paragraph.</td>
<td>This is an image example with a title attribute <img src="app_icon.png" alt="Alternate Message" title="This is a title" /> embedded in a paragraph.</td>
</tr>
<tr>
<td>This is the same image ![image3][] but with the attributes placed later on in the document.<br />
<br />
[image3]: app_icon.png "This is where the title goes" height=40px width=40px</td>
<td>This is the same image <img src="app_icon.png" alt="image3" id="image3" title="This is where the title goes" style="height:40px;width:40px;" /> but with the attributes placed later on in the document.</td>
</tr>
<tr>
<td>When an image is placed in a paragraph, it is wrapped in a <figure> tag ![This is the figure caption][fig_id] [fig_id]: app_icon.png "This is where the title goes" height=80px width=80px</td>
<td>
<p>When an image is placed in a paragraph, it is wrapped in a <figure> tag</p><img src="app_icon.png" alt="This is the figure caption" id="fig_id" title="This is where the title goes" style="height:80px;width:80px;" /> This is the figure caption
</td>
</tr>
</table>
</div>
<h2 class="section-name">Lists</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>
* Milk<br />
* Bread<br />
* Cheese<br />
* Cheddar<br />
* Camembert<br />
* Rice
</td>
<td>
<ul>
<li>Milk</li>
<li>Bread</li>
<li>Cheese
<ul>
<li>Cheddar</li>
<li>Camembert</li>
</ul>
</li>
<li>Rice</li>
</ul>
</td>
</tr>
<tr>
<td>
1. Milk<br />
2. Bread<br />
3. Cheese<br />
1. Cheddar<br />
2. Camembert<br />
4. Rice
</td>
<td>
<ol>
<li>Milk</li>
<li>Bread</li>
<li>Cheese
<ol>
<li>Cheddar</li>
<li>Camembert</li>
</ol>
</li>
<li>Rice</li>
</ol>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Tables</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>
Here is as example of [table][simple_table] followed by a more complex [example][reference_table] from the [documentation](https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide "MultiMarkdown Syntax Guide")<br />
<br />
<pre>
| First Header | Second Header | Third Header |
| :----------- | :-----------: | -------------------: |
| First row | Data | Very long data entry |
| Second row | **Cell** | *Cell* |
[simple_table]
</pre>
<pre>
| | Grouping ||
| First Header | Second Header | Third Header |
| ------------ | :-----------: | -----------: |
| Content | *Long Cell* ||
| Content | **Cell** | Cell |
| New section | More | Data |
| And more | And more |
[Prototype table][reference_table]
</pre>
</td>
<td>
<p>Here is as example of <a href="#simple_table">table</a> followed by a more complex <a href="#reference_table">example</a> from the <a href="https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide" title="MultiMarkdown Syntax Guide">documentation</a></p>
<table>
<caption id="simple_table">
simple_table
</caption>
<colgroup>
<col style="text-align:left;" />
<col style="text-align:center;" />
<col style="text-align:right;" />
</colgroup>
<thead>
<tr>
<th style="text-align:left;">First Header</th>
<th style="text-align:center;">Second Header</th>
<th style="text-align:right;">Third Header</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left;">First row</td>
<td style="text-align:center;">Data</td>
<td style="text-align:right;">Very long data entry</td>
</tr>
<tr>
<td style="text-align:left;">Second row</td>
<td style="text-align:center;"><strong>Cell</strong></td>
<td style="text-align:right;"><em>Cell</em></td>
</tr>
</tbody>
</table>
<table>
<caption id="reference_table">
Prototype table
</caption>
<colgroup>
<col style="text-align:left;" />
<col style="text-align:center;" />
<col style="text-align:right;" />
</colgroup>
<thead>
<tr>
<th style="text-align:left;"></th>
<th style="text-align:center;" colspan="2">Grouping</th>
</tr>
<tr>
<th style="text-align:left;">First Header</th>
<th style="text-align:center;">Second Header</th>
<th style="text-align:right;">Third Header</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left;">Content</td>
<td style="text-align:center;" colspan="2"><em>Long Cell</em></td>
</tr>
<tr>
<td style="text-align:left;">Content</td>
<td style="text-align:center;"><strong>Cell</strong></td>
<td style="text-align:right;">Cell</td>
</tr>
</tbody>
<tbody>
<tr>
<td style="text-align:left;">New section</td>
<td style="text-align:center;">More</td>
<td style="text-align:right;">Data</td>
</tr>
<tr>
<td style="text-align:left;">And more</td>
<td style="text-align:center;">And more</td>
</tr>
</tbody>
</table>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Footnotes</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Here is some text containing a footnote[^somesamplefootnote]. You can then continue your thought...<br />
<br />
[^somesamplefootnote]: Here is the text of the footnote itself.<br />
<br />
Even go to a new paragraph and the footnotes with go to the bottom of the document[^documentdetails].<br />
<br />
[^documentdetails]: Depending on the final form of your document, of course. See the documentation and experiment.<br/><br/>
This footnote has a second paragraph.</td>
<td>
<p>Here is some text containing a footnote<a href="#fn:1" id="fnref:1" title="see footnote" class="footnote">[1]</a>. You can then continue your thought…</p>
<p>Even go to a new paragraph and the footnotes with go to the bottom of the document<a href="#fn:2" id="fnref:2" title="see footnote" class="footnote">[2]</a>.</p>
<div class="footnotes">
<hr />
<ol>
<li id="fn:1">
<p>Here is the text of the footnote itself. <a href="#fnref:1" title="return to article" class="reversefootnote"> ↩</a></p>
</li>
<li id="fn:2">
<p>Depending on the final form of your document, of course. See the documentation and experiment.</p>
<p>This footnote has a second paragraph.<a href="#fnref:2" title="return to article" class="reversefootnote"> ↩</a></p>
</li>
</ol>
</div>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Cross Reference</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>You can place a have a link to another point in your document like this [one][] or you can take you to [another][] place in the doc.<br />
<br />
## one ##<br />
<br />
A simple subheading in a larger document with the same name as the referring tag.<br />
<br />
## Another place in the document [another] ##<br />
<br />
Another place in the document that is referenced by the [another] tag in the heading<br /></td>
<td>
<p>You can place a have a link to another point in your document like this <a href="#one">one</a> or you can take you to <a href="#another">another</a> place in the doc.</p>
<h2 id="one">one</h2>
<p>A simple subheading in a larger document with the same name as the referring tag.</p>
<h2 id="another">Another place in the document</h2>
<p>Another place in the document that is referenced by the [another] tag in the heading</p>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Citations</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Let's cite a fake book.[p. 42][#fake]<br/>
<br/>
[#fake]: John Doe. *A Totally Fake Book*. Vanity Press, 2006.
</td>
<td><p>Let’s cite a fake book.<a class="citation" href="#fn:1" title="Jump to citation">[<span class="locator">p. 42</span>, 1]<span class="citekey" style="display:none">fake</span></a></p>
<div class="footnotes">
<hr />
<ol>
<li id="fn:1" class="citation"><span class="citekey" style="display:none">fake</span><p>John Doe. <em>A Totally Fake Book</em>. Vanity Press, 2006.</p>
</li>
</ol>
</div>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Definition Lists</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>
When you are making you definitions you should note the white space.
<pre>
Apple
: Pomaceous fruit of plants of the genus Malus in
the family Rosaceae.
Also the makers of really great products.
Banana
: 1. A delicious fruit that can be hazardous
if left on the ground.
2. A fruit that comes with it's own packaging
Orange
: The fruit of an evergreen tree of the genus Citrus.
</pre>
</td>
<td>
<p>When you are making you definitions you should note the white space.</p>
<dl>
<dt>Apple</dt>
<dd>
<p>Pomaceous fruit of plants of the genus Malus in the family Rosaceae.</p>
<p>Also the makers of really great products.</p>
</dd>
<dt>Banana</dt>
<dd>
<ol>
<li>
<p>A delicious fruit that can be hazardous if left on the ground.</p>
</li>
<li>
<p>A fruit that comes with it’s own packaging</p>
</li>
</ol>
</dd>
<dt>Orange</dt>
<dd>The fruit of an evergreen tree of the genus Citrus.</dd>
</dl>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Math</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>\\[ {e}^{i\pi }+1=0 \\]</td>
<td><math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
<msup>
<mrow class="MJX-TeXAtom-ORD">
<mi>e</mi>
</mrow>
<mrow class="MJX-TeXAtom-ORD">
<mi>i</mi>
<mi>π<!-- π --></mi>
</mrow>
</msup>
<mo>+</mo>
<mn>1</mn>
<mo>=</mo>
<mn>0</mn>
</math></td>
</tr>
</table>
</div>
<h2 class="section-name">Glossary</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Let's reference a glossary term.[^glossary]<br/><br/>
[^glossary]:glossary: Glossary
A section at the end ...</td>
<td><p>Let’s reference a glossary term.<a href="#fn:1" id="fnref:1" title="see footnote" class="footnote glossary">[1]</a></p>
<div class="footnotes">
<hr />
<ol>
<li id="fn:1">
<span class="glossary name">Glossary</span>: <p>A section at the end … <a href="#fnref:1" title="return to article" class="reversefootnote"> ↩</a></p>
</li>
</ol>
</div>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Acknowledgement</h2>
<div class="section">
<p>Based on the Human Markdown Reference by Édouard Brière.</p>
<p>https://github.com/edouard/human-markdown-reference</p>
<p>Modified for MultiMarkdown syntax by the MMD Community.</p>
<p>For the first interaction I took examples from the following websites.</p>
<dl>
<dt>Byword:</dt>
<dd>http://bywordapp.com/markdown/guide.html</dd>
<dt>PHP Markdown Extra:</dt>
<dd>http://michelf.com/projects/php-markdown/extra</dd>
<dt>MultiMarkdown Guide:</dt>
<dd>https://github.com/fletcher/MultiMarkdown/blob/master/Documentation/MultiMarkdown%20User%27s%20Guide.md</dd>
</dl>
</div>
</body>
</html>