mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
markdown.html
1692 lines (639 loc) · 31.3 KB
/
markdown.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
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<p align="center"><b>Markdownフォーマットを使用してウェブページを書く</b></p>
<p>(このテキストは、<a target="_blank" href="http://daringfireball.net/projects/markdown/syntax">the original Markdown syntax page</a>)のコピーです。</p>
<hr />
<div id="Main">
<div class="article">
<ul>
<li><a href="#overview">概要</a>
<ul>
<li><a href="#philosophy">理念</a></li>
<li><a href="#html">インラインHTML</a></li>
<li><a href="#autoescape">スペシャルキャラクタの自動エスケープ</a></li>
</ul></li>
<li><a href="#block">ブロック要素</a>
<ul>
<li><a href="#p">段落と改行</a></li>
<li><a href="#header">ヘッダ</a></li>
<li><a href="#blockquote">引用</a></li>
<li><a href="#list">リストアイテム</a></li>
<li><a href="#precode">コード</a></li>
<li><a href="#hr">水平線</a></li>
</ul></li>
<li><a href="#span">汎用的なインライン要素</a>
<ul>
<li><a href="#link">リンク</a></li>
<li><a href="#em">強調</a></li>
<li><a href="#code">コード</a></li>
<li><a href="#img">イメージ</a></li>
</ul></li>
<li><a href="#misc">その他</a>
<ul>
<li><a href="#backslash">バックシュラッシュエスケープ</a></li>
<li><a href="#autolink">自動リンク</a></li>
</ul></li>
</ul>
<hr />
<h2 id="overview">概要</h2>
<h3 id="philosophy">理念</h3>
<p>Markdownは、可能な限り簡単に読み、簡単に書くことを目的としています。</p>
<p>しかしながら、何にもまして読みやすいことが重要視されています。
Markdownフォーマットドキュメントは、タグによるマークアップやフォーマットインストラクション無しに、プレインテキストとしてそのまま公開されます。
Markdownのシンタックスは、
<a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a>、
<a href="http://www.aaronsw.com/2002/atx/">atx</a>、
<a href="http://textism.com/tools/textile/">Textile</a>、
<a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>、
<a href="http://www.triptico.com/software/grutatxt.html">Grutatext</a>、
<a href="http://ettext.taint.org/doc/">EtText</a>
を含む幾つかのテキストtoHTMLフィルタに影響を受けました。
しかし、Markdownのシンタックスの一番大きなインスピレーションの源は、プレインテキストメールのフォーマットです。
</p>
<p>このため、Markdownのシンタックスは、完全に句読記号文字から成ります。句読記号文字は、それらが意味するとおりに見えるように慎重に選ばれました。
例えば、言葉の周りのアスタリスクは実際には*強調*のように見えます。Markdownではリストとして表示されます。
あなたがメールを使用したことがあると仮定して、blockquotes(引用)は引用されたテキストのように見えます。
</p>
<h3 id="html">インラインHTML</h3>
<p>Markdownのシンタックスは、1つの事柄を目的としています: ウェブを<em>記述</em>するようなフォーマットとして使用する。</p>
<p>Markdownは、HTMLの代替物ではなく、むしろHTMLに近いと言えます。
シンタックスは非常にコンパクトで、HTMLタグの非常に小さなサブセットのみと一致します。
Markdownのアイディアは、HTMLタグを簡単に挿入できるシンタックスを作成することでは<em>ありません</em>。
私の見解として、HTMLタグは既に簡単に挿入することができるからです。
Markdownのアイディアは、簡単に読め、簡単に書け、散文的に編集できることにあります。
HTMLは<em>出版するための</em>フォーマットです。これに対して、Markdownは<em>書くための</em>フォーマットです。
従って、Markdownフォーマットシンタックスは、プレインテキストで表現することのみに重点を置いています。</p>
<p>Markdownシンタックスで表現できないマークアップには、単純にHTMLそのものを使用できます。
MarkdownからHTMLに切り替える場合、事前に記したり、区切り文字を入れる必要はありません。タグを使用するだけです。</p>
<p>唯一の制限事項は、ブロック要素を使用する場合です - 例 <code><div></code>、<code><table></code>、<code><pre></code>、<code><p></code>等
- これらは空白行で囲まれたコンテンツで分離する必要があります。また、開始および終了タグはタブまた空白でインデントしてはいけません。
Markdownは、余分(不必要)な<code><p></code>タグをブロック要素の周囲に追加することはありません。</p>
<p>例えば、HTMLテーブルをMarkdown記事に追加する場合:</p>
<pre><code>これは通常の段落です。
<table>
<tr>
<td>Foo</td>
</tr>
</table>
これはもう1つの通常の段落です。
</code></pre>
<p>注意: Markdownフォーマットシンタックスはブロック要素の中では処理されません
例、あなたはMarkdown-style <code>*強調*</code> をHTMLブロックの中で使用できません。</p>
<p>汎用的なインライン要素 - 例 <code><span></code>、<code><cite></code>、<code><del></code> - は、
Markdown段落、リスト、ヘッダのどこでも使用することができます。あなたが希望する場合、Markdownフォーマットの
代わりにHTMLタグを使用することもできます。例えば、HTMLの<code><a></code>または<code><img></code>タグをMarkdown
のリンクやイメージのシンタックスの代わりに使用できます。</p>
<p>HTMLのブロック要素と異なり、Markdownシンタックスは汎用的なインライン要素の中でも処理<em>されます</em>。</p>
<h3 id="autoescape">スペシャルキャラクタの自動エスケープ</h3>
<p>HTMLには特別に扱う必要のある2つの文字があります: <code><</code> と <code>&</code>です。左鍵括弧タグの開始に使用し、アンパサンドはHTMLエンティティーを示すために使用します。
これらの文字を使用する場合は、エンティティーとしてエスケープする必要があります。例、<code>&lt;</code> と <code>&amp;</code>です。</p>
<p>特にアンパサンドは、ホームページ製作者泣かせの存在です。‘AT&T’と書きたい場合、‘<code>AT&amp;T</code>’と書く必要があります。
更に、URLの中でもアンパサンドをエスケープする必要があります。従って、次のようにリンクしたい場合:</p>
<pre><code>http://images.google.com/images?num=30&q=larry+bird
</code></pre>
<p>アンカータグ<code>href</code>の属性において、URLを次のようにエンコードする必要があります:</p>
<pre><code>http://images.google.com/images?num=30&amp;q=larry+bird
</code></pre>
<p>言うまでもなく、このことは忘れやすく、恐らく適切にマークアップされたウェブサイトでHTML妥当性エラーが発生する最も一般的な原因となっています。</p>
<p>Markdownは必要に応じてエスケープ処理を行いますので、あなたはこれらの文字を自然に使うことができます。
アンパサンドをHTMLエンティティーの一部として使用したい場合は、そのままの状態にされます。そうで無い場合は、<code>&amp;</code>にエンコードされます。</p>
<p>ですから、あなたが著作権記号を記事に入れたい場合は、次のように記述できます:</p>
<pre><code>&copy;
</code></pre>
<p>Markdownはアンパサンドをそのままにします。しかし、次のように記述すると:</p>
<pre><code>AT&T
</code></pre>
<p>Markdownは次のようにエンコードします:</p>
<pre><code>AT&amp;T
</code></pre>
<p>同様に、Markdownは<a href="#html">inline HTML</a>をサポートします。鍵括弧をHTMLの区切り文字として使用する場合、Markdownは鍵括弧をそのままにします。しかし、次のように記述すると:</p>
<pre><code>4 < 5
</code></pre>
<p>Markdownは次のようにエンコードします:</p>
<pre><code>4 &lt; 5
</code></pre>
<p>しかし、Markdownコードspansとblocksの中では、鍵括弧、アンパサンドは<em>常に</em>自動的にエンコードされます。このことにより、Markdownを使用すると簡単にHTMLコードを記述することができます。
(逆に、生のHTMLでHTMLシンタックスを記述すると酷いことになります。あなたのサンプルコード内の全ての <code><</code> と <code>&</code> をエスケープする必要があるからです。)</p>
<hr />
<h2 id="block">ブロック要素</h2>
<h3 id="p">段落と改行</h3>
<p>A paragraph is simply one or more consecutive lines of text, separated
by one or more blank lines. (A blank line is any line that looks like a
blank line — a line containing nothing but spaces or tabs is considered
blank.) Normal paragraphs should not be intended with spaces or tabs.</p>
<p>The implication of the “one or more consecutive lines of text” rule is
that Markdown supports “hard-wrapped” text paragraphs. This differs
significantly from most other text-to-HTML formatters (including Movable
Type’s “Convert Line Breaks” option) which translate every line break
character in a paragraph into a <code><br /></code> tag.</p>
<p>When you <em>do</em> want to insert a <code><br /></code> break tag using Markdown, you
end a line with two or more spaces, then type return.</p>
<p>Yes, this takes a tad more effort to create a <code><br /></code>, but a simplistic
“every line break is a <code><br /></code>” rule wouldn’t work for Markdown.
Markdown’s email-style <a href="#blockquote">blockquoting</a> and multi-paragraph <a href="#list">list items</a>
work best — and look better — when you format them with hard breaks.</p>
<h3 id="header">ヘッダ</h3>
<p>Markdown supports two styles of headers, <a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a> and <a href="http://www.aaronsw.com/2002/atx/">atx</a>.</p>
<p>Setext-style headers are “underlined” using equal signs (for first-level
headers) and dashes (for second-level headers). For example:</p>
<pre><code>This is an H1
=============
This is an H2
-------------
</code></pre>
<p>Any number of underlining <code>=</code>’s or <code>-</code>’s will work.</p>
<p>Atx-style headers use 1-6 hash characters at the start of the line,
corresponding to header levels 1-6. For example:</p>
<pre><code># This is an H1
## This is an H2
###### This is an H6
</code></pre>
<p>Optionally, you may “close” atx-style headers. This is purely
cosmetic — you can use this if you think it looks better. The
closing hashes don’t even need to match the number of hashes
used to open the header. (The number of opening hashes
determines the header level.) :</p>
<pre><code># This is an H1 #
## This is an H2 ##
### This is an H3 ######
</code></pre>
<h3 id="blockquote">引用</h3>
<p>Markdown uses email-style <code>></code> characters for blockquoting. If you’re
familiar with quoting passages of text in an email message, then you
know how to create a blockquote in Markdown. It looks best if you hard
wrap the text and put a <code>></code> before every line:</p>
<pre><code>> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.
</code></pre>
<p>Markdown allows you to be lazy and only put the <code>></code> before the first
line of a hard-wrapped paragraph:</p>
<pre><code>> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.
</code></pre>
<p>Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by
adding additional levels of <code>></code>:</p>
<pre><code>> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.
</code></pre>
<p>Blockquotes can contain other Markdown elements, including headers, lists,
and code blocks:</p>
<pre><code>> ## This is a header.
>
> 1. This is the first list item.
> 2. This is the second list item.
>
> Here's some example code:
>
> return shell_exec("echo $input | $markdown_script");
</code></pre>
<p>Any decent text editor should make email-style quoting easy. For
example, with BBEdit, you can make a selection and choose Increase
Quote Level from the Text menu.</p>
<h3 id="list">Lists</h3>
<p>Markdown supports ordered (numbered) and unordered (bulleted) lists.</p>
<p>Unordered lists use asterisks, pluses, and hyphens — interchangably
— as list markers:</p>
<pre><code>* Red
* Green
* Blue
</code></pre>
<p>is equivalent to:</p>
<pre><code>+ Red
+ Green
+ Blue
</code></pre>
<p>and:</p>
<pre><code>- Red
- Green
- Blue
</code></pre>
<p>Ordered lists use numbers followed by periods:</p>
<pre><code>1. Bird
2. McHale
3. Parish
</code></pre>
<p>It’s important to note that the actual numbers you use to mark the
list have no effect on the HTML output Markdown produces. The HTML
Markdown produces from the above list is:</p>
<pre><code><ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>
</code></pre>
<p>If you instead wrote the list in Markdown like this:</p>
<pre><code>1. Bird
1. McHale
1. Parish
</code></pre>
<p>or even:</p>
<pre><code>3. Bird
1. McHale
8. Parish
</code></pre>
<p>you’d get the exact same HTML output. The point is, if you want to,
you can use ordinal numbers in your ordered Markdown lists, so that
the numbers in your source match the numbers in your published HTML.
But if you want to be lazy, you don’t have to.</p>
<p>If you do use lazy list numbering, however, you should still start the
list with the number 1. At some point in the future, Markdown may support
starting ordered lists at an arbitrary number.</p>
<p>List markers typically start at the left margin, but may be indented by
up to three spaces. List markers must be followed by one or more spaces
or a tab.</p>
<p>To make lists look nice, you can wrap items with hanging indents:</p>
<pre><code>* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
viverra nec, fringilla in, laoreet vitae, risus.
* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
</code></pre>
<p>But if you want to be lazy, you don’t have to:</p>
<pre><code>* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
viverra nec, fringilla in, laoreet vitae, risus.
* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
</code></pre>
<p>If list items are separated by blank lines, Markdown will wrap the
items in <code><p></code> tags in the HTML output. For example, this input:</p>
<pre><code>* Bird
* Magic
</code></pre>
<p>will turn into:</p>
<pre><code><ul>
<li>Bird</li>
<li>Magic</li>
</ul>
</code></pre>
<p>But this:</p>
<pre><code>* Bird
* Magic
</code></pre>
<p>will turn into:</p>
<pre><code><ul>
<li><p>Bird</p></li>
<li><p>Magic</p></li>
</ul>
</code></pre>
<p>List items may consist of multiple paragraphs. Each subsequent
paragraph in a list item must be intended by either 4 spaces
or one tab:</p>
<pre><code>1. This is a list item with two paragraphs. Lorem ipsum dolor
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
sit amet velit.
2. Suspendisse id sem consectetuer libero luctus adipiscing.
</code></pre>
<p>It looks nice if you indent every line of the subsequent
paragraphs, but here again, Markdown will allow you to be
lazy:</p>
<pre><code>* This is a list item with two paragraphs.
This is the second paragraph in the list item. You're
only required to indent the first line. Lorem ipsum dolor
sit amet, consectetuer adipiscing elit.
* Another item in the same list.
</code></pre>
<p>To put a blockquote within a list item, the blockquote’s <code>></code>
delimiters need to be indented:</p>
<pre><code>* A list item with a blockquote:
> This is a blockquote
> inside a list item.
</code></pre>
<p>To put a code block within a list item, the code block needs
to be indented <em>twice</em> — 8 spaces or two tabs:</p>
<pre><code>* A list item with a code block:
<code goes here>
</code></pre>
<p>It’s worth noting that it’s possible to trigger an ordered list by
accident, by writing something like this:</p>
<pre><code>1986. What a great season.
</code></pre>
<p>In other words, a <em>number-period-space</em> sequence at the beginning of a
line. To avoid this, you can backslash-escape the period:</p>
<pre><code>1986\. What a great season.
</code></pre>
<h3 id="precode">Code Blocks</h3>
<p>Pre-formatted code blocks are used for writing about programming or
markup source code. Rather than forming normal paragraphs, the lines
of a code block are interpreted literally. Markdown wraps a code block
in both <code><pre></code> and <code><code></code> tags.</p>
<p>To produce a code block in Markdown, simply indent every line of the
block by at least 4 spaces or 1 tab. For example, given this input:</p>
<pre><code>This is a normal paragraph:
This is a code block.
</code></pre>
<p>Markdown will generate:</p>
<pre><code><p>This is a normal paragraph:</p>
<pre><code>This is a code block.
</code></pre>
</code></pre>
<p>One level of indentation — 4 spaces or 1 tab — is removed from each
line of the code block. For example, this:</p>
<pre><code>Here is an example of AppleScript:
tell application "Foo"
beep
end tell
</code></pre>
<p>will turn into:</p>
<pre><code><p>Here is an example of AppleScript:</p>
<pre><code>tell application "Foo"
beep
end tell
</code></pre>
</code></pre>
<p>A code block continues until it reaches a line that is not indented
(or the end of the article).</p>
<p>Within a code block, ampersands (<code>&</code>) and angle brackets (<code><</code> and <code>></code>)
are automatically converted into HTML entities. This makes it very
easy to include example HTML source code using Markdown — just paste
it and indent it, and Markdown will handle the hassle of encoding the
ampersands and angle brackets. For example, this:</p>
<pre><code> <div class="footer">
&copy; 2004 Foo Corporation
</div>
</code></pre>
<p>will turn into:</p>
<pre><code><pre><code>&lt;div class="footer"&gt;
&amp;copy; 2004 Foo Corporation
&lt;/div&gt;
</code></pre>
</code></pre>
<p>Regular Markdown syntax is not processed within code blocks. E.g.,
asterisks are just literal asterisks within a code block. This means
it’s also easy to use Markdown to write about Markdown’s own syntax.</p>
<h3 id="hr">Horizontal Rules</h3>
<p>You can produce a horizontal rule tag (<code><hr /></code>) by placing three or
more hyphens or asterisks on a line by themselves. If you wish, you
may use spaces between the hyphens or asterisks. Each of the following
lines will produce a horizontal rule:</p>
<pre><code>* * *
***
*****
- - -
---------------------------------------
</code></pre>
<hr />
<h2 id="span">Span Elements</h2>
<h3 id="link">Links</h3>
<p>Markdown supports two style of links: <em>inline</em> and <em>reference</em>.</p>
<p>In both styles, the link text is delimited by [square brackets].</p>
<p>To create an inline link, use a set of regular parentheses immediately
after the link text’s closing square bracket. Inside the parentheses,
put the URL where you want the link to point, along with an <em>optional</em>
title for the link, surrounded in quotes. For example:</p>
<pre><code>This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
</code></pre>
<p>Will produce:</p>
<pre><code><p>This is <a href="http://example.com/" title="Title">
an example</a> inline link.</p>