pubdoc/Markdown-Syntax-CN/basic.html

   1 <!DOCTYPE html>
   2 <html lang="zh-CN">
   3     <head>
   4         <meta charset="UTF-8">
   5         <title>Markdown 语法说明(简体中文版)</title>
   6         <link rel="stylesheet" media="all" href="Han/han.min.css">
   7         <link rel="stylesheet" media="all" href="stylesheets/main.css">
   8     </head>
   9     <body>
  10         <div class="wikistyle">
  11
  12 <p><strong>声明：</strong> 这份文档派生(fork)于<a href="http://markdown.tw/">繁体中文版</a>，在此基础上进行了繁体转简体工作，并进行了适当的润色。此文档用 Markdown 语法编写，你可以到这里<a href="http://gitcafe.com/riku/Markdown-Syntax-CN/blob/master/basics.md">查看它的源文件</a>。「繁体中文版的原始文件可以<a href="https://github.com/othree/markdown-syntax-zhtw/blob/master/basics.md">查看这里</a>」--By @<a href="http://twitter.com/riku">riku</a> / 本项目托管于 <a href="http://gitcafe.com/riku/Markdown-Syntax-CN">GitCafe</a></p>
  13
  14 <p><strong>注：</strong> 本项目同时也托管于 <a href="https://github.com/riku/Markdown-Syntax-CN">Github</a>上，请通过 fork＋pull request 方式来帮忙改进本项目。</p>
  15
  16 <h1>Markdown: Basics （快速入门） / (<a href="./index.html">点击查看完整语法说明</a>)</h1>
  17
  18 <h2>Getting the Gist of Markdown's Formatting Syntax</h2>
  19
  20 <p>此页提供了 Markdown 的简单概念， <a href="http://gitcafe.com/riku/Markdown-Syntax-CN/blob/master/syntax.md" title="Markdown Syntax">语法说明</a> 页提供了完整详细的文档，说明了每项功能。但是 Markdown 其实很简单就可以上手，此页文档提供了一些范例，并且每个范例都会提供输出的 HTML 结果。</p>
  21
  22 <p>其实直接试试看也是一个很不错的方法， <a href="http://daringfireball.net/projects/markdown/dingus" title="Markdown Dingus">Dingus</a> 是一个网页应用程序，你可以把自已编写的 Markdown 文档转成 XHTML。</p>
  23
  24 <h2>段落、标题、区块代码</h2>
  25
  26 <p>一个段落是由一个以上的连接的行句组成，而一个以上的空行则会划分出不同的段落（空行的定义是显示上看起来像是空行，就被视为空行，例如有一行只有空白和 tab，那该行也会被视为空行），一般的段落不需要用空白或换行缩进。</p>
  27
  28 <p>Markdown 支持两种标题的语法，<a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a> 和 <a href="http://www.aaronsw.com/2002/atx/">atx</a> 形式。Setext 形式是用底线的形式，利用 <code>=</code> （最高阶标题）和 <code>-</code> （第二阶标题），Atx 形式在行首插入 1 到 6 个 <code>#</code> ，对应到标题 1 到 6 阶。</p>
  29
  30 <p>区块引用则使用 email 形式的 '<code>&gt;</code>' 角括号。</p>
  31
  32 <p>Markdown 语法:</p>
  33
  34 <pre><code>A First Level Header
  35 ====================
  36 A Second Level Header
  37 ---------------------
  38
  39 Now is the time for all good men to come to
  40 the aid of their country. This is just a
  41 regular paragraph.
  42
  43 The quick brown fox jumped over the lazy
  44 dog's back.
  45 ### Header 3
  46
  47 &gt; This is a blockquote.
  48 &gt;
  49 &gt; This is the second paragraph in the blockquote.
  50 &gt;
  51 &gt; ## This is an H2 in a blockquote
  52 </code></pre>
  53
  54 <p>输出 HTML 为：</p>
  55
  56 <pre><code>&lt;h1&gt;A First Level Header&lt;/h1&gt;
  57 &lt;h2&gt;A Second Level Header&lt;/h2&gt;
  58 &lt;p&gt;Now is the time for all good men to come to
  59 the aid of their country. This is just a
  60 regular paragraph.&lt;/p&gt;
  61 &lt;p&gt;The quick brown fox jumped over the lazy
  62 dog's back.&lt;/p&gt;
  63 &lt;h3&gt;Header 3&lt;/h3&gt;
  64 &lt;blockquote&gt;
  65 &lt;p&gt;This is a blockquote.&lt;/p&gt;
  66 &lt;p&gt;This is the second paragraph in the blockquote.&lt;/p&gt;
  67 &lt;h2&gt;This is an H2 in a blockquote&lt;/h2&gt;
  68 &lt;/blockquote&gt;
  69 </code></pre>
  70
  71 <h3>修辞和强调</h3>
  72
  73 <p>Markdown 使用星号和底线来标记需要强调的区段。</p>
  74
  75 <p>Markdown 语法:</p>
  76
  77 <pre><code>Some of these words *are emphasized*.
  78 Some of these words _are emphasized also_.
  79 Use two asterisks for **strong emphasis**.
  80 Or, if you prefer, __use two underscores instead__.
  81 </code></pre>
  82
  83 <p>输出 HTML 为:</p>
  84
  85 <pre><code>&lt;p&gt;Some of these words &lt;em&gt;are emphasized&lt;/em&gt;.
  86 Some of these words &lt;em&gt;are emphasized also&lt;/em&gt;.&lt;/p&gt;
  87 &lt;p&gt;Use two asterisks for &lt;strong&gt;strong emphasis&lt;/strong&gt;.
  88 Or, if you prefer, &lt;strong&gt;use two underscores instead&lt;/strong&gt;.&lt;/p&gt;
  89 </code></pre>
  90
  91 <h2>列表</h2>
  92
  93 <p>无序列表使用星号、加号和减号来做为列表的项目标记，这些符号是都可以使用的，使用星号：</p>
  94
  95 <pre><code>* Candy.
  96 * Gum.
  97 * Booze.
  98 </code></pre>
  99
 100 <p>加号：</p>
 101
 102 <pre><code>+ Candy.
 103 + Gum.
 104 + Booze.
 105 </code></pre>
 106
 107 <p>和减号</p>
 108
 109 <pre><code>- Candy.
 110 - Gum.
 111 - Booze.
 112 </code></pre>
 113
 114 <p>都会输出 HTML 为：</p>
 115
 116 <pre><code>&lt;ul&gt;
 117 &lt;li&gt;Candy.&lt;/li&gt;
 118 &lt;li&gt;Gum.&lt;/li&gt;
 119 &lt;li&gt;Booze.&lt;/li&gt;
 120 &lt;/ul&gt;
 121 </code></pre>
 122
 123 <p>有序的列表则是使用一般的数字接着一个英文句点作为项目标记：</p>
 124
 125 <pre><code>1. Red
 126 2. Green
 127 3. Blue
 128 </code></pre>
 129
 130 <p>输出 HTML 为：</p>
 131
 132 <pre><code>&lt;ol&gt;
 133 &lt;li&gt;Red&lt;/li&gt;
 134 &lt;li&gt;Green&lt;/li&gt;
 135 &lt;li&gt;Blue&lt;/li&gt;
 136 &lt;/ol&gt;
 137 </code></pre>
 138
 139 <p>如果你在项目之间插入空行，那项目的内容会用 <code>&lt;p&gt;</code> 包起来，你也可以在一个项目内放上多个段落，只要在它前面缩排 4 个空白或 1 个 tab 。</p>
 140
 141 <pre><code>* A list item.
 142 With multiple paragraphs.
 143
 144 * Another item in the list.
 145 </code></pre>
 146
 147 <p>输出 HTML 为：</p>
 148
 149 <pre><code>&lt;ul&gt;
 150 &lt;li&gt;&lt;p&gt;A list item.&lt;/p&gt;
 151 &lt;p&gt;With multiple paragraphs.&lt;/p&gt;&lt;/li&gt;
 152 &lt;li&gt;&lt;p&gt;Another item in the list.&lt;/p&gt;&lt;/li&gt;
 153 &lt;/ul&gt;
 154 </code></pre>
 155
 156 <h3>链接</h3>
 157
 158 <p>Markdown 支援两种形式的链接语法： <em>行内</em> 和 <em>参考</em> 两种形式，两种都是使用角括号来把文字转成连结。</p>
 159
 160 <p>行内形式是直接在后面用括号直接接上链接：</p>
 161
 162 <pre><code>This is an [example link](http://example.com/).
 163 </code></pre>
 164
 165 <p>输出 HTML 为：</p>
 166
 167 <pre><code>&lt;p&gt;This is an &lt;a href="http://example.com/"&gt;
 168 example link&lt;/a&gt;.&lt;/p&gt;
 169 </code></pre>
 170
 171 <p>你也可以选择性的加上 title 属性：</p>
 172
 173 <pre><code>This is an [example link](http://example.com/ "With a Title").
 174 </code></pre>
 175
 176 <p>输出 HTML 为：</p>
 177
 178 <pre><code>&lt;p&gt;This is an &lt;a href="http://example.com/" title="With a Title"&gt;
 179 example link&lt;/a&gt;.&lt;/p&gt;
 180 </code></pre>
 181
 182 <p>参考形式的链接让你可以为链接定一个名称，之后你可以在文件的其他地方定义该链接的内容：</p>
 183
 184 <pre><code>I get 10 times more traffic from [Google][1] than from
 185 [Yahoo][2] or [MSN][3].
 186
 187 [1]: http://google.com/ "Google"
 188 [2]: http://search.yahoo.com/ "Yahoo Search"
 189 [3]: http://search.msn.com/ "MSN Search"
 190 </code></pre>
 191
 192 <p>输出 HTML 为：</p>
 193
 194 <pre><code>&lt;p&gt;I get 10 times more traffic from &lt;a href="http://google.com/"
 195 title="Google"&gt;Google&lt;/a&gt; than from &lt;a href="http://search.yahoo.com/"
 196 title="Yahoo Search"&gt;Yahoo&lt;/a&gt; or &lt;a href="http://search.msn.com/"
 197 title="MSN Search"&gt;MSN&lt;/a&gt;.&lt;/p&gt;
 198 </code></pre>
 199
 200 <p>title 属性是选择性的，链接名称可以用字母、数字和空格，但是不分大小写：</p>
 201
 202 <pre><code>I start my morning with a cup of coffee and
 203 [The New York Times][NY Times].
 204
 205 [ny times]: http://www.nytimes.com/
 206 </code></pre>
 207
 208 <p>输出 HTML 为：</p>
 209
 210 <pre><code>&lt;p&gt;I start my morning with a cup of coffee and
 211 &lt;a href="http://www.nytimes.com/"&gt;The New York Times&lt;/a&gt;.&lt;/p&gt;
 212 </code></pre>
 213
 214 <h3>图片</h3>
 215
 216 <p>图片的语法和链接很像。</p>
 217
 218 <p>行内形式（title 是选择性的）：</p>
 219
 220 <pre><code>![alt text](/path/to/img.jpg "Title")
 221 </code></pre>
 222
 223 <p>参考形式：</p>
 224
 225 <pre><code>![alt text][id]
 226
 227 [id]: /path/to/img.jpg "Title"
 228 </code></pre>
 229
 230 <p>上面两种方法都会输出 HTML 为：</p>
 231
 232 <pre><code>&lt;img src="/path/to/img.jpg" alt="alt text" title="Title" /&gt;
 233 </code></pre>
 234
 235 <h3>代码</h3>
 236
 237 <p>在一般的段落文字中，你可以使用反引号 <code>`</code> 来标记代码区段，区段内的 <code>&amp;</code>、<code>&lt;</code> 和 <code>&gt;</code> 都会被自动的转换成 HTML 实体，这项特性让你可以很容易的在代码区段内插入 HTML 码：</p>
 238
 239 <pre><code>I strongly recommend against using any `&lt;blink&gt;` tags.
 240
 241 I wish SmartyPants used named entities like `&amp;mdash;`
 242 instead of decimal-encoded entites like `&amp;#8212;`.
 243 </code></pre>
 244
 245 <p>输出 HTML 为：</p>
 246
 247 <pre><code>&lt;p&gt;I strongly recommend against using any
 248 &lt;code&gt;&amp;lt;blink&amp;gt;&lt;/code&gt; tags.&lt;/p&gt;
 249 &lt;p&gt;I wish SmartyPants used named entities like
 250 &lt;code&gt;&amp;amp;mdash;&lt;/code&gt; instead of decimal-encoded
 251 entites like &lt;code&gt;&amp;amp;#8212;&lt;/code&gt;.&lt;/p&gt;
 252 </code></pre>
 253
 254 <p>如果要建立一个已经格式化好的代码区块，只要每行都缩进 4 个空格或是一个 tab 就可以了，而 <code>&amp;</code>、<code>&lt;</code> 和 <code>&gt;</code> 也一样会自动转成 HTML 实体。</p>
 255
 256 <p>Markdown 语法:</p>
 257
 258 <pre><code>If you want your page to validate under XHTML 1.0 Strict,
 259 you've got to put paragraph tags in your blockquotes:
 260
 261 &lt;blockquote&gt;
 262 &lt;p&gt;For example.&lt;/p&gt;
 263 &lt;/blockquote&gt;
 264 </code></pre>
 265
 266 <p>输出 HTML 为：</p>
 267
 268 <pre><code>&lt;p&gt;If you want your page to validate under XHTML 1.0 Strict,
 269 you've got to put paragraph tags in your blockquotes:&lt;/p&gt;
 270 &lt;pre&gt;&lt;code&gt;&amp;lt;blockquote&amp;gt;
 271 &amp;lt;p&amp;gt;For example.&amp;lt;/p&amp;gt;
 272 &amp;lt;/blockquote&amp;gt;
 273 &lt;/code&gt;&lt;/pre&gt;
 274 </code></pre>
 275
 276
 277         </div>
 278
 279         <div id="comments">
 280
 281 <div id="disqus_thread"></div>
 282 <script type="text/javascript">
 283     /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
 284     var disqus_shortname = 'wowubuntu'; // required: replace example with your forum shortname
 285
 286     /* * * DON'T EDIT BELOW THIS LINE * * */
 287     (function() {
 288         var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
 289         dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
 290         (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
 291     })();
 292 </script>
 293 <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
 294 <a href="http://disqus.com" class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>
 295
 296         </div>
 297
 298     </body>
 299 </html>