Markdown - 扩展语法

扩展语法

列表

有序列表

有序列表可以通过阿拉伯数字后跟 . 或者 ) 来创建，数字不必递增连续。

1 2	`1. 列表项一 1) 列表项二`

列表项一

列表项二

无序列表

无序列表可以通过短横线 -、星号 * 或者加号 + 来开头，后面需要跟一个空格来分隔文本内容。

1
2
3

- 列表项一
* 列表项二
+ 列表项三

列表项一

列表项二

列表项三

任务列表

通过在普通列表项中添加 [ ] 或者 [x] 来渲染任务列表项。

1
2
3

- [x] 待办事项一
- [ ] 待办事项二
- [ ] 待办事项三

待办事项一
待办事项二
待办事项三

代码块

推荐使用围栏代码块语法来排版代码块，即使用 ``` 来包裹代码块，并且指定语法高亮语言。

html语法高亮

```html
<html>
  <head>
  </head>
</html>
```

json语法高亮

```json
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```

如果需要展示代码块原文 Markdown（就像上面展示的例子那样），可以在最外层使用更多数量的反引号开始，闭合的反引号数量等于开始的数量即可。

````
```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```
````

表格的使用

表格排版

使用短横线 --- 来分隔表头和表身，使用竖线 | 来分隔列，每行开头和结尾的竖线是可选的。

| Syntax      | Description |
| ---         | ---         |
| Header      | Title       |
| Paragraph   | Text        |

Syntax	Description
Header	Title
Paragraph	Text

表格中的内容也可以进行排版，比如加粗、强调文本，插入超链接等。但仅限于使用“行级元素”进行排版，不能使用“块级元素”，比如不能使用标题、块引用、列表、分隔线等。

表格对齐

如果需要左对齐、居中对齐或者右对齐表格内容，可以通过在 --- 中添加冒号 : 实现。冒号仅出现在左边表示左对齐，出现在两边表示居中对齐，仅出现在右边表示右对齐。

| Syntax      | Description | Test Text     |
| :---        | :---:       | ---:          |
| Header      | Title       | Here's this   |
| Paragraph   | Text        | And more      |

Syntax	Description	Test Text
Header	Title	Here’s this
Paragraph	Text	And more

如果需要在表格内容中使用竖线 | ，那就需要对其进行转义。可以使用 \| 转义，但更稳妥的做法是写竖线的 HTML实体 | 表示，因为有的 Markdown 引擎不能正确处理表格内容中的 \|

块引用的使用

块引用

要创建块引用的话仅需在段落前加上大于号 >

1
2
3

> 原谅我这一生不羁放纵爱自由，也会怕有一天会跌倒
> 背弃了理想 ，谁人都可以
> 哪会怕有一天只你共我

原谅我这一生不羁放纵爱自由，也会怕有一天会跌倒
背弃了理想，谁人都可以
哪会怕有一天只你共我

块引用分段

如果需要分段的话可以在分段空行前加上一个 >

> 原谅我这一生不羁放纵爱自由，也会怕有一天会跌倒
> 背弃了理想 ，谁人都可以
>
> 哪会怕有一天只你共我

原谅我这一生不羁放纵爱自由，也会怕有一天会跌倒
背弃了理想，谁人都可以
哪会怕有一天只你共我

块引用嵌套

块引用可以嵌套使用，在段落前添加两个大于号 >> 表示两层嵌套。

> 原谅我这一生不羁放纵爱自由，也会怕有一天会跌倒
> 背弃了理想 ，谁人都可以
>
> > 哪会怕有一天只你共我

原谅我这一生不羁放纵爱自由，也会怕有一天会跌倒
背弃了理想，谁人都可以
哪会怕有一天只你共我

块引用包含其它元素

块引用能够包含其他大部分语法元素。CommonMark 规范将块引用定义为容器块，容器块可以包含任意块级元素和行级元素，也就是说块引用可以包含其他任意元素。

1
2
3

> 段落是块级元素
>
> **加粗**和*强调*是行级元素

段落是块级元素
加粗和强调是行级元素

脚注的使用

脚注允许你添加注释和引用，而不会使文档正文混乱。当你创建脚注时，带有链接的上标数字会出现在你引用脚注的位置。读者可以单击链接以跳转至页面底部的脚注内容处。

本文参考了 [Markdown 指南中文版](https://www.markdown.xyz/) 的 Markdown基本语法[^1] 和 Markdown扩展语法[^2]。

[^1]: [Markdown 基本语法](https://www.markdown.xyz/basic-syntax/)

[^2]: [Markdown 扩展语法](https://www.markdown.xyz/extended-syntax/)