Markdown 语法指南-CSDN博客

本文链接：https://blog.csdn.net/weixin_46483660/article/details/148151344

Markdown 语法指南

一、Markdown 简介

Markdown 是一种轻量级标记语言，由约翰・格鲁伯（John Gruber）在 2004 年创建。它允许人们使用易读易写的纯文本格式编写文档，然后转换成有效的 XHTML（或者 HTML）文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。

Markdown 的目标是实现「易读易写」，让文档既适合直接阅读源代码，又能通过简单转换得到丰富格式的展示效果。它广泛应用于文档编写、博客创作、电子书制作、技术文档撰写等场景，GitHub、GitLab、语雀、飞书等众多平台都支持 Markdown 语法。

二、基础语法

1. 标题

使用 # 表示标题，一个 # 是一级标题，两个 # 是二级标题，以此类推，最多支持六级标题。

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

2. 段落

直接输入文本即为段落，段落之间需要空一行。例如：

这是第一段文字。

这是第二段文字。

3. 换行

在一行的末尾添加两个或多个空格，然后按下回车键，即可实现换行。也可以使用
标签进行强制换行。

4. 强调

加粗：使用 ** 包裹文本，例如 这是加粗的文字，显示效果为 这是加粗的文字。
斜体：使用 * 包裹文本，例如 这是斜体的文字，显示效果为 这是斜体的文字 。
加粗斜体：使用 *** 包裹文本，例如 这是加粗斜体的文字，显示效果为 *这是加粗斜体的文字* 。

5. 列表

无序列表：使用 -、+ 或 * 作为列表标记，例如：

- 列表项1
+ 列表项2
* 列表项3

显示效果为：

列表项 1
列表项 2
列表项 3
有序列表：使用数字和 . 作为列表标记，例如：

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

显示效果为：

第一项
第二项
第三项

列表嵌套：在列表项内再次使用列表标记，即可实现列表嵌套，例如：

1. 一级列表项1
   - 二级列表项1.1
   - 二级列表项1.2
2. 一级列表项2
   - 二级列表项2.1

显示效果为：

一级列表项 1

- 二级列表项 1.1
- 二级列表项 1.2

一级列表项 2

- 二级列表项 2.1

6. 链接

行内式链接：使用链接文本的格式，例如百度，显示效果为百度。
参考式链接：先定义链接标签，再在需要的地方引用，例如：

这是一个 [百度][baidu] 的链接。
[baidu]: https://www.baidu.com

显示效果同样为这是一个百度的链接。

7. 图片

使用![替代文本](图片地址)如果图片地址正确，会显示对应图片，若无法显示，则会展示替代文本示例图片。也可以使用参考式语法，和链接类似。

8. 代码

行内代码：使用反引号包裹代码，例如 print(“Hello, World!”) ，显示效果为 print(“Hello, World!”) 。
代码块：使用三个反引号 ```包裹代码，并可以在开头指定编程语言，例如：

```python
def add(a, b):
    return a + b
```

显示效果为：

def add(a, b):
    return a + b

三、进阶语法

1. 引用

使用 > 表示引用，例如：

> 这是一段引用的文字。
> > 这是嵌套的引用。

显示效果为：

这是一段引用的文字。

这是嵌套的引用。

2. 表格

使用 | 分隔列，使用 - 表示表头和内容的分隔，例如：

| 姓名 | 年龄 | 城市 |
|------|------|------|
| 张三 | 25   | 北京 |
| 李四 | 30   | 上海 |

显示效果为：

姓名	年龄	城市
张三	25	北京
李四	30	上海

3. 脚注

使用 [^脚注标记] 表示脚注引用，在文档末尾使用 [^脚注标记]: 脚注内容定义脚注，例如：

这是一段包含脚注的文字[^1]。
[^1]: 这是脚注的具体内容。

显示效果中，引用处会显示上标数字 1，点击可查看脚注内容这是脚注的具体内容。

4. 任务列表

使用 - [ ] 表示未完成的任务，- [x] 表示已完成的任务，例如：

- [ ] 任务1
- [x] 任务2

显示效果为：

任务1
任务2

四、高级拓展语法

1. 特殊符号转义

当需要显示 Markdown 语法中的特殊符号（如 #、*、_、{}、[]、()、>、+、-、.、! 等）时，可在符号前添加反斜杠 \ 进行转义。例如：

\# 这不会被识别为标题，而是显示#

显示效果为：

这不会被识别为标题，而是显示#

2. 数学公式

在一些支持的 Markdown 环境（如 Jupyter Notebook、某些博客平台）中，可使用 LaTeX 语法插入数学公式。

行内公式：使用 $ 包裹公式，例如 $E=mc^2$ ，显示效果为 (E=mc^2) 。
块级公式：使用 $$ 包裹公式，公式会单独占一行并居中显示。例如：

$$
\sum_{i = 1}^{n} i = \frac{n(n + 1)}{2}
$$

显示效果为：

$\sum_{i = 1}^{n} i = \frac{n(n + 1)}{2}$

3. 流程图与图表

通过特定语法或插件可以绘制流程图、时序图等。以流程图为例，在支持 Mermaid 语法的环境中，可这样编写：

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

显示效果为：

4. 折叠内容

在部分支持的平台（如飞书文档）中，可使用 HTML 标签实现内容折叠效果：

<details>
<summary>点击展开</summary>
这是折叠起来的内容，只有点击后才会显示。
</details>

点击展开这是折叠起来的内容，只有点击后才会显示。

5. 目录生成

在一些 Markdown 编辑器或平台中，通过特定语法或插件可自动生成目录。例如，在某些支持的环境中，使用 [TOC] 即可根据文档中的标题自动生成目录：

@[toc]
# 一级标题
## 二级标题
### 三级标题

显示时会在 [TOC] 位置生成对应目录结构，方便用户快速导航。

五、工具推荐

Typora：一款简洁美观且功能强大的 Markdown 编辑器，支持实时预览，在 Windows、Mac 和 Linux 系统上均可使用。
VS Code：通过安装 Markdown 相关插件（如 Markdown All in One、Markdown Preview Enhanced 等），可以实现高效的 Markdown 编写和预览。
Obsidian：适合用于知识管理和笔记记录，对 Markdown 格式有良好的支持，还具备强大的双链笔记功能。