# Markdown 基本語法 ## 段落 非常自然，一行文字就是一個段落。 比如 ``` 這是一個段落。 ``` 會被解釋成 ``` <p>這是一個段落。</p> ``` 如果你需要另起一段，請在兩個段落之間隔一個空行。 ``` 這是一個段落。 這是另一個段落。 ``` 會解釋成 ``` <p>這是一個段落<p> <p>這是另一個段落</p> ``` 不隔一個空行的換行行為，在一些編輯器中被解釋為換行，即插入一個`<br />`標簽。對與另外一些編輯器，會被解釋為插入一個空格。對于后者，若要插入換行標簽，請在當前一行的結尾打兩個空格。 ## 粗體、斜體 可以使用星號`*`或下劃線`_`指定粗體或者斜體。 ``` *這是斜體* _這也是斜體_ **這是粗體** ***這是粗體+斜體*** ``` 會被解釋成 ``` <em>這是斜體</em> <em>這也是斜體</em> <strong>這是粗體</strong> <strong><em>這是粗體+斜體</strong></em> ``` ## 刪除線 一部分編輯器支持刪除線，它不是經典markdown中的要素。用波浪線`~`定義刪除線。 ``` ~~就像這樣~~ ``` 會被解釋成 ``` <strike>就像這樣</strike> ``` ## 標題 markdown總支持1~6六級標題，通過在一行之前加上不同數量的井號來表示。 ``` # 這是 H1 # ## 這是 H2 ## ### 這是 H3 ### ... ###### 這是 H6 ###### ``` 行尾可以加上任意數量的井號字符，這些字符不會算作標題內容。通常會加上相等數量的字符以保持對稱。 此外，H1和H2也可以采用在文本下方添加底線來實現，比如： ``` 這是 H1 ======= 這是 H2 ------- ``` ## 引用 通過在行首加上大于號`>`來添加引用格式。 ``` > 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. ``` 引用可以嵌套： ``` > This is the first level of quoting. > > > This is nested blockquote. > > Back to the first level. ``` 也可以嵌套其他格式： ``` > ## 這是一個標題。 > > 1. 這是第一行列表項。 > 2. 這是第二行列表項。 > > 給出一些例子代碼： > > return shell_exec("echo $input | $markdown_script"); ``` ## 列表 無序列表使用星號、加號或是減號作為列表標記： ``` * Red * Green * Blue ``` 等同于 ``` + Red + Green + Blue ``` 和 ``` - Red - Green - Blue ``` 有序列表則使用數字接著一個英文句點： ``` 1. Bird 2. McHale 3. Parish ``` 數字并不會影響輸出的 HTML 結果，也就是說上面的例子等同于： ``` 1. Bird 1. McHale 1. Parish ``` ## 內聯代碼 用反引號`` ` ``來標記內聯代碼，它們會解釋成`<code>`標簽。如果代碼的內容中有反引號，請用兩個反引號包裹。代碼中的`&`、`<`、`>`符號都會自動轉義，請放心使用。 ## 代碼區域 有兩種方式標記代碼區域，原生風格是行首縮進死個空格。 ``` 這是一個普通段落： 這是一個代碼區塊。 ``` 會被解釋成 ``` <p>這是一個普通段落：</p> <pre><code>這是一個代碼區塊。 </code></pre> ``` 除了行首的4個空格會被移出，其它不變。像內聯代碼一樣，上述三種符號也會被轉義。但在代碼段中，星號之類的markdown標記符號則不會解析。 還有一種是github的風格，代碼段的前后用三個反引號獨占一行來標記。  目前主流編輯器都支持這種風格。 ## 分隔線 你可以在一行中用三個以上的星號、減號、底線來建立一個分隔線，行內不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立分隔線： ``` * * * *** ***** - - - --------------------------------------- ``` ## 鏈接 ``` [an example](http://example.com/) [an example](http://example.com/ "Optional Title") ``` 會被解釋為 ``` <a href='http://example.com/'>an example</a> <a href='http://example.com/' title="Optional Title">an example</a> ``` 除了上面的行內式，也可以使用參考式： ``` [an example][id] ``` 然后在任意空白位置定義： ``` [id]: http://example.com/ "Optional Title" ``` ## 圖像 ```   ``` 會被解釋為 ``` <img src='/path/to/img.jpg' alt='Alt text' /> <img src='/path/to/img.jpg' alt='Alt text' title='Optional Title' /> ``` 同樣，圖像也有類似的參考式語法。 ## 自動鏈接 如果鏈接的地址和名字重復，可以用尖括號語法將其簡化。 ``` <http://example.com/> ``` 就相當于 ``` [http://example.com/](http://example.com/) ``` 切記，大多數編輯器都會自動將符合url規則的東西視為鏈接，并且解釋成鏈接。很多時候作者由于疏忽等緣故，鏈接和后面的中文之間缺少空格，導致鏈接不正常。所以我建議，鏈接要么加上尖括號，要么兩端加上空格。 ## 轉義 markdown支持在以下字符前面插入反斜杠 ``` \ 反斜線 ` 反引號 * 星號 _ 底線 {} 花括號 [] 方括號 () 括弧 # 井字號 + 加號 - 減號 . 英文句點 ! 驚嘆號 ``` 插入之后，將不再解析這些字符，而是原樣輸出。 ## 表格 表格是github風格獨有的語法，但近年來漸漸被大多數編輯器支持。 ``` | Item | Value | Qty | | :------- | ----: | :---: | | Computer | $1600 | 5 | | Phone | $12 | 12 | | Pipe | $1 | 234 | ``` 會被解釋成 ``` <table> <thead> <tr> <th align="left">Item</th> <th align="right">Value</th> <th align="center">Qty</th> </tr> </thead> <tbody><tr> <td align="left">Computer</td> <td align="right">$1600</td> <td align="center">5</td> </tr> <tr> <td align="left">Phone</td> <td align="right">$12</td> <td align="center">12</td> </tr> <tr> <td align="left">Pipe</td> <td align="right">$1</td> <td align="center">234</td> </tr> </tbody></table> ``` 要注意第二行的冒號決定了居左居右還是居中，如果你不加冒號，默認是居左的。 另外可以把第一行去掉，做成沒有表頭的表格，但第二行始終是要有的。 ## 內聯 HTML markdown 的語法簡潔，但有其局限性，所以特意保留了內聯html這種方式。任何html標簽及其內容，都會原樣輸出到結果中。也就是說，標簽中的星號等作為markdown結構的符號，以及構成html標簽和實體的符號，都不會做任何轉義。