Markdown 语法指南

完整的 Markdown 语法教程,从基础到进阶,助您快速掌握 Markdown

什么是 Markdown?

Markdown 是一种轻量级标记语言,由 John Gruber 于 2004 年创建。 它使用简单的纯文本格式编写文档,可以轻松转换为 HTML 等格式。 Markdown 广泛应用于技术文档、博客写作、README 文件等场景。

基础语法

1. 标题(Headers)

使用 # 号表示标题,# 的数量代表标题级别:

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

2. 文本格式

Markdown 语法支持多种文本格式:

**粗体文本**
*斜体文本*
***粗斜体文本***
~~删除线文本~~

3. 列表

无序列表

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

有序列表

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

4. 链接和图片

链接

[链接文本](https://example.com)
[带标题的链接](https://example.com "链接标题")

图片

![图片描述](image-url.jpg)
![图片描述](image-url.jpg "图片标题")

5. 引用(Blockquotes)

> 这是一段引用文本
> 可以跨越多行
>
> > 嵌套引用

6. 代码

行内代码

使用 `code` 表示行内代码

代码块

function hello() {
  console.log("Hello, World!");
}

扩展语法

7. Markdown 表格(Tables)

Markdown 表格是最常用的扩展语法之一:

| 列 1 | 列 2 | 列 3 |
|------|------|------|
| 内容 1 | 内容 2 | 内容 3 |
| 内容 4 | 内容 5 | 内容 6 |

对齐方式

| 左对齐 | 居中对齐 | 右对齐 |
|:-------|:--------:|-------:|
| 左 | 中 | 右 |

8. 任务列表(Task Lists / Markdown Checklist)

Markdown 任务列表用于创建待办事项:

- [x] 已完成任务
- [ ] 未完成任务
- [ ] 另一个待办事项
  - [x] 子任务 1
  - [ ] 子任务 2

9. 脚注(Footnotes)

这是一段带脚注的文本[^1]。

[^1]: 这是脚注内容。

10. 水平分隔线

---
***
___

11. 转义字符

使用反斜杠 \ 转义特殊字符:

\*不是斜体\*
\# 不是标题

GitHub Flavored Markdown (GFM)

自动链接

URL 和邮箱地址会自动转换为链接:

https://example.com
user@example.com

删除线

~~删除的文本~~

表情符号

:smile: :heart: :thumbsup:

最佳实践

1. 文档结构

  • 使用清晰的标题层级,不要跳级
  • 一级标题用作文档标题,通常只有一个
  • 合理使用列表和表格组织信息

2. 代码块

  • 始终指定代码块的语言,以获得正确的语法高亮
  • 行内代码用于简短的代码片段或命令
  • 代码块用于多行代码或完整示例

3. Markdown 表格

  • 保持表格简洁,列数不宜过多
  • 使用对齐方式提升可读性
  • 复杂表格考虑使用 HTML 或导出为其他格式

4. 任务列表

  • 使用 Markdown Checklist 管理待办事项
  • 定期更新任务状态
  • 可以嵌套使用以表示子任务

常用 Markdown 编辑器

  • 在线编辑器:Markdown Online(本站)、Dillinger、StackEdit
  • 桌面编辑器:Typora、Mark Text、Visual Studio Code
  • 移动端:iA Writer、Bear(iOS)、Markor(Android)

Markdown 的应用场景

  • 技术文档:API 文档、用户手册、技术规范
  • 博客写作:静态博客(Jekyll、Hugo、Hexo)
  • GitHub/GitLab:README.md、Issue、Pull Request、Wiki
  • 笔记应用:Notion、Obsidian、Joplin
  • 论坛社区:Reddit、Stack Overflow、Discord
  • 演示文稿:Reveal.js、Marp

学习资源

立即开始使用 Markdown

现在您已经了解了 Markdown 语法,可以立即使用我们的 Markdown 在线编辑器开始创作。 支持实时预览、Markdown 转 PDFMarkdown 转 Word等功能, 助您高效完成文档编写。