Skip to main content

Markdown 指南

Summary

Markdown 语法指南。先交代 Markdown 的来历：2004 年由 John Gruber 创造，以纯文本存储、少量标记即可排版，能导出富文本或 HTML。随后逐项演示语法：由空行分隔的段落，一到六级标题，加粗、斜体、删除线三种强调，无序、有序与任务三种列表，行内与行间代码块，链接与图片，引用块，用管道符和冒号控制对齐的表格，以及三连字符的分隔线。每种语法都给出源代码与浏览器窗口中的实际渲染效果，方便对照。

参考资料​

简介​

2004 年，约翰·格鲁伯（John Gruber）创造了 Markdown，一种专门针对网络写作的文本标记语言。使用 Markdown，你只需在写作过程中插入少量的标记符号，就能很轻松地进行排版（例如设置标题、加粗、列表、引用等）。

Markdown 文档以纯文本格式存储，这意味着，它们可以用几乎任一文本编辑器打开。同时，又能通过 Markdown 编辑器导出为带排版的富文本文档、HTML 网页等等。纯粹、简洁、易用、灵活，都是人们喜欢 Markdown 的原因。

推荐一个我常用的 Markdown 排版工具软件：Typora。

warning

本文仅说明语法规则，不包含格式与排版建议。

段落​

段落 是由一个或多个连续的 文本行 组成，前后要有至少 1 个 空行。

60 Bmarkdown
第一段
第一句
第二句

第二段
第三句
第四句
http://localhost:3000

第一段 第一句 第二句

第二段 第三句 第四句

标题​

使用 井号（#）表示 标题，1 – 6 个井号（#）分别对应 1 – 6 级标题。

165 Bmarkdown
# 一级标题示例

## 二级标题示例

### 三级标题示例

#### 四级标题示例

##### 五级标题示例

###### 六级标题示例

普通文本示例
http://localhost:3000

一级标题示例

二级标题示例

三级标题示例

四级标题示例

五级标题示例
六级标题示例

普通文本示例

强调​

加粗​

使用 2 个 星号（**）或 下划线（__）包围文本表示 加粗。

33 Bmarkdown
这是一个 **加粗** 示例。
http://localhost:3000

这是一个 加粗 示例。

斜体​

使用 1 个 星号（*）或 下划线（_）包围文本表示 斜体。

31 Bmarkdown
这是一个 _斜体_ 示例。
http://localhost:3000

这是一个 斜体 示例。

删除线​

使用 2 个 波浪线（~~）包围文本表示 删除线。

36 Bmarkdown
这是一个 ~~删除线~~ 示例。
http://localhost:3000

这是一个 删除线 示例。

列表​

无序列表​

使用 连字符（-）、星号（*）或 加号（+）表示 无序列表。

50 Bmarkdown
- 无序列表 1
- 无序列表 2
- 无序列表 3
http://localhost:3000
  • 无序列表 1
  • 无序列表 2
  • 无序列表 3

有序列表​

使用 数字 + 句点 表示 有序列表。

53 Bmarkdown
1. 有序列表 1
2. 有序列表 2
3. 有序列表 3
http://localhost:3000
  1. 有序列表 1
  2. 有序列表 2
  3. 有序列表 3

任务列表​

使用 [ ] 或 [x] 表示 任务列表。

62 Bmarkdown
- [x] 任务列表 1
- [ ] 任务列表 2
- [x] 任务列表 3
http://localhost:3000
  • 任务列表 1
  • 任务列表 2
  • 任务列表 3

代码块​

行内代码​

使用 1 个 反引号（`）表示 行内代码。

13 Bmarkdown
`Lorem ipsum`
http://localhost:3000

Lorem ipsum

行间代码​

使用 3 个 反引号（```）表示 行间代码。

113 Bmarkdown
```cpp
#include <bits/stdc++.h>
using namespace std;

int main()
{
	cout<<"Hello, world!"<<'\n';
	return 0;
}
```
http://localhost:3000
102 Bcpp
#include <bits/stdc++.h>
using namespace std;

int main()
{
	cout<<"Hello, world!"<<'\n';
	return 0;
}

链接​

使用 [链接文本](链接地址) 插入 链接。

35 Bmarkdown
[示例链接](https://example.com)
http://localhost:3000

示例链接

图片​

使用 ![替代文本](图片链接) 插入 图片。

58 Bmarkdown
![示例图片](https://dummyimage.com/250.png&text=Image)
http://localhost:3000

示例图片

引用​

使用 大于号（>）表示 引用。

39 Bmarkdown
> 第一段
>
> 第二段
>
> 第三段
http://localhost:3000

第一段

第二段

第三段

表格​

使用 管道符（|）划分单元格，第二行使用 冒号（:）和 连字符（-）设置对齐方式。

211 Bmarkdown
| 此列左对齐 | 此列居中对齐 | 此列右对齐 |
| :--------- | :----------: | ---------: |
| 内容示例 1 |  内容示例 2  | 内容示例 3 |
| 内容示例 4 |  内容示例 5  | 内容示例 6 |
http://localhost:3000
此列左对齐此列居中对齐此列右对齐
内容示例 1内容示例 2内容示例 3
内容示例 4内容示例 5内容示例 6

分隔线​

使用不少于 3 个 连字符（-）或 星号（*）表示 分隔线。该行不能包含其他内容，但可以插入空格。

25 Bmarkdown
第一段

---

第二段
http://localhost:3000

第一段

第二段