Markdown 格式详解

网络风云

已于 2025-02-23 20:37:01 修改

阅读量1w

点赞数 23

文章标签：开发语言前端

于 2025-02-12 17:00:00 首次发布

本文链接：https://blog.csdn.net/weixin_42998312/article/details/145488279

版权

Markdown 是一种轻量级标记语言，设计初衷是让文档的格式更易读、易写，且兼容纯文本格式。Markdown 格式在编写博客、技术文档、笔记、说明书等场景中非常受欢迎。它通过简单的标记语法来定义文档的格式，而无需复杂的排版工具。

Markdown 格式被广泛用于 GitHub、GitLab、Jupyter Notebook、博客平台等，几乎所有支持文本编辑器的地方都可以使用。

1. 基础语法

1.1 标题

Markdown 支持六个级别的标题（从 H1 到 H6）。通过在文本前加上 # 符号来表示标题级别。# 后面需要跟一个空格，然后是标题内容。

示例：

# 这是 H1 标题

## 这是 H2 标题

### 这是 H3 标题

#### 这是 H4 标题

##### 这是 H5 标题

###### 这是 H6 标题

输出：

这是 H1 标题

这是 H2 标题

这是 H3 标题

这是 H4 标题

这是 H5 标题

这是 H6 标题

1.2 段落

段落在 Markdown 中直接书写，段落之间用空行分隔。每个段落是由一系列的文本组成，通常不需要特殊标记。

示例：

这是第一段。

这是第二段。

输出：

这是第一段。

这是第二段。

1.3 换行

在 Markdown 中，若需要在段落中插入换行符，则需在行尾添加两个空格并回车。

示例：

这是一行。

这是一行之后换行的文本。

输出：

这是一行。
这是一行之后换行的文本。

1.4 强调文本

斜体：使用单个 * 或 _ 来表示斜体。
加粗：使用双 ** 或 __ 来表示加粗。
斜体加粗：使用三个 *** 或 ___ 来表示斜体加粗。

示例：

*斜体文本*

**加粗文本**

***斜体加粗文本***

输出：

斜体文本
加粗文本
斜体加粗文本

1.5 列表

无序列表：用 -、* 或 + 开始每一项。
有序列表：使用数字加点（1.、2.）来标记每一项。

示例：

- 项目 1- 项目 2 - 子项目 2.1 - 子项目 2.2- 项目 3

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

输出：

项目 1
项目 2
- 子项目 2.1
- 子项目 2.2
项目 3

第一项
第二项
第三项

1.6 链接

Markdown 支持两种格式的链接：

行内链接：使用 [链接文本](URL)。
参考式链接：先声明链接标签，再用 [链接文本][标签] 来引用。

示例：

[百度](https://www.baidu.com)

[Google]: https://www.google.com

我喜欢访问 [Google]。

输出：

百度

我喜欢访问 [Google]。

1.7 图片

图片的语法和链接相似，区别在于前面加上 !。

示例：

![图片描述](https://example.com/image.jpg)

输出：

1.8 代码

Markdown 支持内联代码和代码块：

内联代码：用反引号 ` 包裹代码。
代码块：使用三个反引号 ``` 来标记代码块。

示例：

这是 `代码` 内联示例。

这是代码块示例。

输出：

这是代码内联示例。

这是代码块示例。

2. 高级用法

2.1 表格

Markdown 支持基本的表格语法。使用 | 分隔列，- 用于分隔表头和表格内容。

示例：

| 姓名 | 年龄 | 性别 |

| ---- | ---- | ---- |

| 小明 | 25 | 男 |

| 小红 | 22 | 女 |

输出：

姓名	年龄	性别
小明	25	男
小红	22	女

2.2 引用

使用 > 来创建引用块，通常用于引用他人或书籍中的文字。

示例：

> 这是引用的文字。

输出：

这是引用的文字。

2.3 任务列表

任务列表是带有勾选框的列表项，可以通过 - [ ] 和 - [x] 来表示未完成和已完成任务。

示例：

- [ ] 完成文档撰写- [x] 完成代码编写

输出：

完成文档撰写
完成代码编写

2.4 分隔线

使用三个或更多的 *、- 或 _ 可以创建水平分隔线。

示例：

---

输出：

2.5 HTML 标签

Markdown 允许直接嵌入 HTML 标签，支持更复杂的布局。

示例：

这是一个段落，包含 加粗 的文本。

输出：

这是一个段落，包含 加粗 的文本。

3. 常见应用场景

3.1 技术文档编写

由于其简洁易读，Markdown 广泛应用于软件项目的文档编写。GitHub 和 GitLab 中的 README 文件通常采用 Markdown 格式，帮助开发者高效编写文档、发布项目说明和更新日志。

3.2 博客文章写作

许多博客平台（如 Hexo、Jekyll）采用 Markdown 作为默认的文章编写格式。Markdown 格式允许用户在不需要关注排版的情况下专注于内容创作。

3.3 笔记与文档管理

Markdown 适用于个人笔记和文档管理工具（如 Obsidian、Notion、Typora）。其简洁的语法让用户可以快速记录和管理自己的想法。

3.4 代码注释与说明

开发者在撰写代码时，常常使用 Markdown 来编写注释和说明文档。这样不仅提高了代码的可读性，还能轻松生成项目文档。

4. 注意事项

4.1 Markdown 渲染差异

不同的 Markdown 渲染器对语法的支持可能有所不同。常见的 Markdown 渲染引擎如 GitHub Flavored Markdown (GFM)、CommonMark 和 Pandoc 之间可能存在一些差异。因此，在编写文档时，尽量参考目标平台的支持文档。

4.2 排版限制

Markdown 在排版上相对简单，对于复杂的表格、页面布局等需求，可能不如 HTML 灵活。因此，在有特殊排版要求时，可以考虑混合使用 Markdown 和 HTML。

4.3 图片和链接路径

在使用图片和链接时，确保路径的正确性。相对路径和绝对路径在不同平台上的表现可能不同，尤其在使用 GitHub 等托管平台时，要确保图片和资源能正常显示。

4.4 扩展语法

部分平台支持 Markdown 扩展语法，如脚注、数学公式、Mermaid 图表等。要根据实际平台的支持情况选择是否使用这些扩展。

Markdown 是一种非常方便的标记语言，通过简单的语法，开发者和写作者能够轻松地撰写格式化的文本内容。Markdown 的广泛应用使得它成为了技术文档、博客写作、笔记记录等多种场景中的首选工具。掌握 Markdown 的基本语法及高级用法后，可以帮助用户高效地编写、编辑和管理文档。