|
1 <h3>Phrase Emphasis</h3> |
|
2 |
|
3 <pre><code>*italic* **bold** |
|
4 _italic_ __bold__ |
|
5 </code></pre> |
|
6 |
|
7 <h3>Links</h3> |
|
8 |
|
9 <p>Inline:</p> |
|
10 |
|
11 <pre><code>An [example](http://url.com/ "Title") |
|
12 </code></pre> |
|
13 |
|
14 <p>Reference-style labels (titles are optional):</p> |
|
15 |
|
16 <pre><code>An [example][id]. Then, anywhere |
|
17 else in the doc, define the link: |
|
18 |
|
19 [id]: http://example.com/ "Title" |
|
20 </code></pre> |
|
21 |
|
22 <h3>Images</h3> |
|
23 |
|
24 <p>Inline (titles are optional):</p> |
|
25 |
|
26 <pre><code> |
|
27 </code></pre> |
|
28 |
|
29 <p>Reference-style:</p> |
|
30 |
|
31 <pre><code>![alt text][id] |
|
32 |
|
33 [id]: /url/to/img.jpg "Title" |
|
34 </code></pre> |
|
35 |
|
36 <h3>Headers</h3> |
|
37 |
|
38 <p>Setext-style:</p> |
|
39 |
|
40 <pre><code>Header 1 |
|
41 ======== |
|
42 |
|
43 Header 2 |
|
44 -------- |
|
45 |
|
46 </code></pre> |
|
47 |
|
48 <p>atx-style (closing #'s are optional):</p> |
|
49 |
|
50 <pre><code># Header 1 #</code></pre> |
|
51 <pre><code>## Header 2 ##</code></pre> |
|
52 |
|
53 <h3>Lists</h3> |
|
54 |
|
55 <p>Ordered, without paragraphs:</p> |
|
56 |
|
57 <pre><code>1. Foo |
|
58 2. Bar |
|
59 |
|
60 </code></pre> |
|
61 |
|
62 <p>Unordered, with paragraphs:</p> |
|
63 |
|
64 <pre><code>* A list item. |
|
65 |
|
66 With multiple paragraphs. |
|
67 |
|
68 * Bar |
|
69 </code></pre> |
|
70 |
|
71 <p>You can nest them:</p> |
|
72 |
|
73 <pre><code>* First list |
|
74 * Illas |
|
75 1. first item |
|
76 2. second item |
|
77 * nested item |
|
78 3. third item |
|
79 * back to first list |
|
80 </code></pre> |
|
81 |
|
82 <h3>Blockquotes</h3> |
|
83 |
|
84 <pre><code>> Email-style angle brackets |
|
85 |
|
86 > are used for blockquotes. |
|
87 |
|
88 > > And, they can be nested. |
|
89 |
|
90 > > |
|
91 > * You can quote a list. |
|
92 > * Etc. |
|
93 </code></pre> |
|
94 |
|
95 <h3>Code Spans</h3> |
|
96 |
|
97 <pre><code>`<code>` spans are delimited |
|
98 by backticks. |
|
99 |
|
100 You can include literal backticks |
|
101 like `` `this` ``. |
|
102 </code></pre> |
|
103 |
|
104 <h3>Preformatted Code Blocks</h3> |
|
105 |
|
106 <p>Indent every line of a code block by at least 4 spaces or 1 tab, and use a colon at the end of the preceding paragraph.</p> |
|
107 |
|
108 <pre><code>This is a normal paragraph: |
|
109 |
|
110 This is a preformatted |
|
111 code block. |
|
112 |
|
113 Preceded by a space, the colon |
|
114 disappears. : |
|
115 |
|
116 This is a preformatted |
|
117 code block. |
|
118 </code></pre> |
|
119 |
|
120 <h3>Horizontal Rules</h3> |
|
121 |
|
122 <p>Three or more dashes or asterisks:</p> |
|
123 |
|
124 <pre><code>--- |
|
125 |
|
126 * * * |
|
127 |
|
128 - - - - |
|
129 </code></pre> |
|
130 |
|
131 <h3>Manual Line Breaks</h3> |
|
132 |
|
133 <p>End a line with two or more spaces:</p> |
|
134 |
|
135 <pre><code>Roses are red, |
|
136 Violets are blue. |
|
137 </code></pre> |
|
138 |
|
139 |