MarkDown语法指北

本页最后更新时间：2022年7月21日

参考教程

Markdown 语法速查表 | Markdown 官方教程

此文档采用markdown语法编写，你所看到的即使渲染后的结构，源码可以在GitHub仓库查看

标题

要创建标题，请在单词或短语前面添加井号 (#) 。# 的数量代表了标题的级别。例如，添加三个 # 表示创建一个三级标题 (<h3>) (例如：### My Header)。

示例：

1
2
3
4
5
6
7
8

# h1
## h2
### h3
#### h4
##### h5
###### h6
不同的 Markdown 应用程序处理 `#` 和标题之间的空格方式并不一致。
为了兼容考虑，请用一个空格在 `#` 和标题之间进行分隔。

效果：

h1

h2

h3

h4

h5

h6

段落

要创建段落，请使用空白行将一行或多行文本进行分隔。

不要用空格（spaces）或制表符（ tabs）缩进段落。

示例：

1

这是一段话

效果：

这是一段话

换行

在一行的末尾添加两个或多个空格，然后按回车键,即可创建一个换行(<br>)。

几乎每个 Markdown 应用程序都支持两个或多个空格进行换行，称为 结尾空格（trailing whitespace) 的方式，但这是有争议的，因为很难在编辑器中直接看到空格，并且很多人在每个句子后面都会有意或无意地添加两个空格。由于这个原因，你可能要使用除结尾空格以外的其它方式来换行。幸运的是，几乎每个 Markdown 应用程序都支持另一种换行方式：HTML 的 <br> 标签。

为了兼容性，请在行尾添加“结尾空格”或 HTML 的 <br> 标签来实现换行。

还有两种其他方式我并不推荐使用。CommonMark 和其它几种轻量级标记语言支持在行尾添加反斜杠 (\) 的方式实现换行，但是并非所有 Markdown 应用程序都支持此种方式，因此从兼容性的角度来看，不推荐使用。并且至少有两种轻量级标记语言支持无须在行尾添加任何内容，只须键入回车键（return）即可实现换行。

示例：

1
2
3
4

使用结尾空格换行  
下一行内容

使用标签换行<br>下一行内容

效果：

使用结尾空格换行
下一行内容

使用标签换行
下一行内容

强调

加粗

要加粗文本，请在单词或短语的前后各添加两个星号（asterisks）或下划线（underscores）。如需加粗一个单词或短语的中间部分用以表示强调的话，请在要加粗部分的两侧各添加两个星号（asterisks）。

Markdown 应用程序在如何处理单词或短语中间的下划线上并不一致。为兼容考虑，在单词或短语中间部分加粗的话，请使用星号（asterisks）。

斜体

要用斜体显示文本，请在单词或短语前后添加一个星号（asterisk）或下划线（underscore）。要斜体突出单词的中间部分，请在字母前后各添加一个星号，中间不要带空格。

要用斜体显示文本，请在单词或短语前后添加一个星号（asterisk）或下划线（underscore）。要斜体突出单词的中间部分，请在字母前后各添加一个星号，中间不要带空格。

加粗和斜体

要同时用粗体和斜体突出显示文本，请在单词或短语的前后各添加三个星号或下划线。要加粗并用斜体显示单词或短语的中间部分，请在要突出显示的部分前后各添加三个星号，中间不要带空格。

Markdown 应用程序在处理单词或短语中间添加的下划线上并不一致。为了实现兼容性，请使用星号将单词或短语的中间部分加粗并以斜体显示，以示重要。

示例：

1
2
3
4
5

加**粗示**范

斜*体示*范

加***粗斜体示***范

效果：

加粗示范

斜体示范

加粗斜体示范