comparison gpp/templates/core/markdown_help.html @ 127:2d299909e074

Adding markdown help to comments and forums. Still need to add it to a few other places that use the markItUp editor.
author Brian Neal <bgneal@gmail.com>
date Mon, 16 Nov 2009 01:00:28 +0000
parents
children ca7d619ee27b
comparison
equal deleted inserted replaced
126:b0d62247c3e4 127:2d299909e074
1 <table>
2 <tr><th>&nbsp;</th><th>Type This</th><th>To See This</th></tr>
3 <tr>
4 <th>Paragrahs</th>
5 <td>
6 <pre>Paragraphs must be separated by a blank line.
7
8 Here is another paragraph.
9 </pre></td>
10 <td>
11 <p>Paragraphs must be separated by a blank line.</p>
12 <p>Here is another paragraph.</p>
13 </td>
14 </tr>
15 <tr>
16 <th>Manual Line Breaks</th>
17 <td>
18 <pre>To insert a line break
19 end a line with two or more spaces.
20 </pre></td>
21 <td>
22 <p>To insert a line break <br />
23 end a line with two or more spaces.</p>
24 </td>
25 </tr>
26 <tr>
27 <th>Emphasis</th>
28 <td>
29 <pre>*italic*
30 _italic_
31 **bold**
32 __bold__</pre></td>
33 <td><i>italic</i><br />
34 <i>italic</i><br />
35 <b>bold</b><br />
36 <b>bold</b></td>
37 </tr>
38 <tr>
39 <th>Inline links</th>
40 <td>A link to [Google](http://google.com).</td>
41 <td>A link to <a href="http://google.com">Google</a>.</td>
42 </tr>
43 <tr>
44 <th>Reference links</th>
45 <td>A link to [Google][id]. Then anywhere else in the
46 text, define the link on its own line.<br/>
47 [id]: http://google.com </td>
48 <td>A link to <a href="http://google.com">Google</a>. Then
49 anywhere else in the text, define the link on its own line.</td>
50 </tr>
51 <tr>
52 <th>Inline Images</th>
53 <td>![alt text](/static/icons/emoticon_smile.png "Smile").</td>
54 <td><img src="/static/icons/emoticon_smile.png" alt="alt text" title="Smile" /></td>
55 </tr>
56 <tr>
57 <th>Reference Images</th>
58 <td>![alt text][id]<br />
59 [id]: /static/icons/emoticon_smile.png "Smile"</td>
60 </td>
61 <td><img src="/static/icons/emoticon_smile.png" alt="alt text" title="Smile" /></td>
62 </tr>
63 <tr>
64 <th>Bullet List</th>
65 <td>
66 <pre>* One
67 * Two
68 * Three</pre></td>
69 <td>
70 <ul>
71 <li>One</li>
72 <li>Two</li>
73 <li>Three</li>
74 </ul>
75 </td>
76 </tr>
77 <tr>
78 <th>Numbered List</th>
79 <td>
80 <pre>1. One
81 1. Two
82 1. Three</pre></td>
83 <td>
84 <ol>
85 <li>One</li>
86 <li>Two</li>
87 <li>Three</li>
88 </ol>
89 </td>
90 </tr>
91 <tr>
92 <th>Blockquotes</th>
93 <td><pre>John said:
94 &gt; Email style angle brackets
95 &gt; are used for quotes.</pre></td>
96 <td><p>John said:</p>
97 <blockquote><p>Email-style angle brackets are used for blockquotes.</p></blockquote></td>
98 </tr>
99 <tr>
100 <th>Code Spans</th>
101 <td><pre>`&lt;code&gt;` spans are delimited by backticks.</pre></td>
102 <td><p><code>&lt;code&gt;</code> spans are delimited by backticks.</p></td>
103 </tr>
104 <tr>
105 <th>Code Blocks</th>
106 <td><pre>First insert a blank line.
107
108 Then indent every line
109 of a code block by at least
110 4 spaces. This is useful to
111 display tablature.
112 </pre></td>
113 <td>
114 <p>First insert a blank line.</p>
115
116 <pre><code>Then indent every line
117 of a code block by at least
118 4 spaces. This is useful to
119 display tablature.
120 </code></pre>
121 </td>
122 </tr>
123 <tr>
124 <th>Header 1</th>
125 <td>
126 <pre>Header 1
127 ========
128 </pre></td>
129 <td><h1>Header 1</h1></td>
130 </tr>
131 <tr>
132 <th>Header 2</th>
133 <td>
134 <pre>Header 2
135 --------
136 </pre></td>
137 <td><h2>Header 2</h2></td>
138 </tr>
139 <tr>
140 <th>Header 1</th>
141 <td><pre># Header 1</pre></td>
142 <td><h1>Header 1</h1></td>
143 </tr>
144 <tr>
145 <th>Header 2</th>
146 <td><pre>## Header 2</pre></td>
147 <td><h2>Header 2</h2></td>
148 </tr>
149 <tr>
150 <th>Header 3</th>
151 <td><pre>### Header 3</pre></td>
152 <td><h3>Header 3</h3></td>
153 </tr>
154 <tr>
155 <th>Header 6</th>
156 <td><pre>###### Header 6</pre></td>
157 <td><h6>Header 6</h6></td>
158 </tr>
159 </table>
160 <p>
161 More help:
162 </p>
163 <ul>
164 <li><a href="http://daringfireball.net/projects/markdown/basics" target="_blank">Markdown Basics</a></li>
165 <li><a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown Reference</a></li>
166 </ul>
167 <p>Hit <code>ESC</code> or click the <code>X</code> to close this window.</p>