如何使用 Markdown 撰寫文件

Markdown

“

Markdown 是 John Gruber 於 2004 年創立的輕量級標記語言，可以用易讀、易寫的純文字格式撰寫文件。
透過適當的轉換工具，Markdown 文件可以匯出為 HTML、Word、圖片、PDF、EPUB 等格式。
Markdown 文件的副檔名通常是 .md 或 .markdown。

Markdown 應用

Markdown 可以搭配 GitBook 等工具撰寫電子書。

許多網站使用 Markdown 撰寫說明文件或論壇貼文，例如 GitHub、簡書、Reddit、Diaspora、Stack Exchange、OpenStreetMap、SourceForge 等。

Markdown 基礎語法

標題 | Title

Markdown 標題有兩種格式。

1. 使用 = 和 - 標記一級和二級標題

这是H1的标题
===========

这是H2的标题
-----------

2. 使用 # 標記

使用 # 號可表示 1-6 級標題，一級標題對應一個 # 號，二級標題對應兩個 # 號，依此類推。

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

段落 | Paragraph

Markdown 段落不需要特殊格式，直接輸入文字即可。若要在段落內換行，可在行尾加上兩個以上的空格，再按 Enter。

段落之間留一個空白行，就能開始新的段落。

斜體與粗體 | Phrase Emphasis

Markdown 使用 *文字* 或 _文字_ 表示斜體，使用 **文字** 或 __文字__ 表示粗體。

列表 | List

Markdown 支援無序列表和有序列表。

無序列表

無序列表使用 星號* 加號+ 或是 減號- 作為清單標記；標記後加上一個空格，再輸入內容：

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项

- 第一项
- 第二项
- 第三项

有序列表

有序列表使用數字並加上 . 號來表示，例如：

1. 第一项
2. 第二项
3. 第三项

列表巢狀

列表巢狀只需在子列表中的選項前面加上四個空格即可：

1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

區塊引用 | Blockquotes

Markdown 區塊引用是在段落開頭使用 > 符號，後面接一個 空格：

>Hi, this is xxxbrian.
>Brian's Blog
>等青春轻飘的烟雾把少年的欢乐袅袅曳去，之后，我们就能取得一切值得吸取的东西。 ——普希金

另外區塊是可以巢狀的，一個 > 符號是最外層，兩個 > 符號是第一層巢狀，依此類推：

> 最外层
> > 第一层嵌套
> > > 第二层嵌套

區塊中使用列表

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

列表中使用區塊

+ 第一项
    > Brian's Blog
    > Hi, this is xxxbrian.
+ 第二项

程式碼 | Code

段落中的函式名稱或程式碼片段，可以用 反引號` 包起來，例如 `程式碼`。若要顯示函式名稱 printf()，可以這樣寫：

`printf()`函数

程式碼區塊

程式碼區塊可縮排 4 個空格 或一個定位字元（Tab）。

$(document).ready(function () {
    alert('RUNOOB');
});

顯示結果如下：

$(document).ready(function () {
alert('RUNOOB');
});

你也可以用 ``` 包裹一段程式碼，並指定一種語言（也可以不指定）：

$(document).ready(function () {
    alert('RUNOOB');
});

顯示結果如下：

$(document).ready(function () {
    alert('RUNOOB');
});

超連結 | Link

連結 使用方法如下：

[链接名称](链接地址)

或者

<链接地址>

例如：

这是一个链接 [Brian's Blog](https://xxxbrian.me)

這是一個連結 Brian's Blog

直接使用連結網址

链接 <https://xxxbrian.me>

連結 <https://xxxbrian.me>

進階連結

參照式連結可以先用標籤標記連結，再於文件末尾統一指定對應網址：

这个链接用 1 作为网址变量 [Google][1]
这个链接用 Brian's Blog 作为网址变量 [xxxbrian][xxxbrian]

[1]: http://www.google.com/
[xxxbrian]: https://xxxbrian.me

圖片 | Images

Markdown 圖片語法格式如下：

![alt 属性文本](图片地址)

![alt 属性文本](图片地址 "可选标题")

• 開頭一個驚嘆號 !
• 接著用一組方括號放入圖片的替代文字。
• 再用一組小括號放入圖片網址；後面可加上以引號包住的 'title' 文字作為選用標題。

使用範例：

![xxxbrian 图标](https://raw.githubusercontent.com/xxxbrian/xxxbrian.github.io/master/img/xxxbrian-192x192.png "xxxbrian")

表格 | Tables

Markdown 製作表格使用 | 來分隔不同的儲存格，使用 - 來分隔表頭和其他列。

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

表格對齊

• -: 設定內容和標題列靠右對齊。
• :- 設定內容和標題列靠左對齊。
• :-: 設定內容和標題列置中對齊。

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

跳脫 | Backslash Escapes

Markdown 使用了許多特殊符號來表示特定的意義，如果需要顯示特定的符號則需要使用跳脫字元，Markdown 使用反斜線跳脫特殊字元：

**文本加粗** 
\*\* 正常显示星号 \*\*

Markdown 支援以下這些符號前面加上反斜線來協助插入普通的符號：

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号