Markdown 标准语法

文档用途

介绍 markdown 标准语法.

快速上手

建议直接阅读 一分钟上手 - markdown 官网.
并紧接着完成 十分钟教程 - markdown 官网.
另外也推荐阅读中文资料 Markdown 官方教程.

由于官方教程已然简洁且完善地介绍了 markdown,
因此这篇文档将只介绍 容易被忽略但有用 的语法.

段落与换行

如果希望在一个段落内 换行, 则应该在需要换行的地方添加 \ 符号.

原文

这是第一行文字,\
这是第二行文字,\
与第三行文字一起组成一个段落.

显示效果

这是第一行文字,
这是第二行文字,
与第三行文字一起组成一个段落.

如果希望开启一个新的 段落, 则应该 空一行.

原文

这是原文中的第一行.\
这是原文中的第二行.

这是原文中的第三行.

显示效果

这是原文中的第一行.
这是原文中的第二行.

这是原文中的第三行.

如果不希望换行, 也不希望换段落, 只是想在 markdown 原文中分成几行来写.
则不需要任何额外的处理, 保证原文中的每一行都紧挨在一起即可.

原文

这是原文中的第一行,
这是原文中的第二行,
这是原文中的第三行.

显示效果

这是原文中的第一行, 这是原文中的第二行, 这是原文中的第三行.

TIP

有些时候可能想多空几行, 此时可以使用 HTML 标签 <br />.

有序列表

无需手动设置成正确的递增数字, 只需要设置初始数字即可.
因此通常我们只需要将有序列表的每行行首都写成 1. 即可.

原文

1. First
1. Second
1. Third

显示效果

1. First
2. Second
3. Third

外部链接

除了这种最常用的链接写法:

[text](http://b.org/)

还可以将文本与链接地址像这样分开写:

[text][id]
<!-- 省略中间这部分内容 -->
<!-- 需要空一行才能使得链接语法生效 -->

[id]: http://b.org/ "title"
<!-- "title" 是可选项, 用于指定鼠标悬停时显示的文本 -->

分开写主要的使用场景是:

• 某个链接地址被多次使用, 希望能减少书写的重复.
• 某个链接特别长, 影响 markdown 原文的排版或阅读.

内部链接

如果想要通过链接跳转至某个标题, 可以在括号内使用 #title 语法.
例如在这篇文档中, 原文 [快速上手](#快速上手) 的显示效果为 快速上手.

INFO

# 符号后不能有空格, 英文字母应全部小写.
例如标题为 GitLab Wiki, 那么链接应该是 [GitLab Wiki](#gitlab-wiki).

表格

WARNING

表格语法不在 markdown 标准内, 但在实践中可以当作是标准语法.
因为其受到了极其广泛的支持, 并且语法统一.

表格语法举例:

| header | header | header |
| - | - | - |
| cell 1 | cell 2 | cell 3 |
| cell 4 | cell 5 is longer | cell 6 is much longer than the others, but that's ok. It eventually wraps the text when the cell is too large for the display size. |
| cell 7 |        | cell 9 |

header	header	header
cell 1	cell 2	cell 3
cell 4	cell 5 is longer	cell 6 is much longer than the others, but that's ok. It eventually wraps the text when the cell is too large for the display size.
cell 7		cell 9

TIP

可以通过 <br /> 这个 HTML 标签来实现表格内的文本换行.

设置对齐格式

| 左对齐 | 居中对齐 | 右对齐 |
| :- | :-: | -: |
| 1 | 2 | 3 |
| 4 | 5 | 6 |

左对齐	居中对齐	右对齐
1	2	3
4	5	6