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