1. 首页
  2. 博客
  3. 指南

Markdown 语法速查表:GitHub 风格语法与示例

一份实用的 Markdown 语法速查表,涵盖标题、列表、链接、图片、代码、表格、任务列表、提示框和脚注,附带可直接复制的 GitHub Flavored Markdown 示例,新手也能快速上手。

Markdown 是书写格式化文本最简单的方式,即使作为纯文本也依然清晰易读。README 文件、技术文档、笔记、聊天消息和静态网站都在使用它。这份速查表涵盖了您真正会用到的语法,重点介绍 GitHub-Flavored Markdown(GFM)——GitHub、GitLab、大多数文档工具以及 Markdown Preview Editor 所支持的 Markdown 方言。

下面的每个示例都可以粘贴到在线编辑器中,左右对照查看效果。

标题

在行首输入一到六个 #,后面加一个空格。一个 # 是页面标题,## 是章节,### 是小节。

markdown# 页面标题
## 章节
### 小节
#### 更小的标题

每个文档只保留一个 # 标题,并且不要跳级(例如从 ## 直接跳到 ####)。屏幕阅读器和搜索引擎会根据标题结构理解页面内容,大多数预览工具也会据此生成目录。

段落与换行

段落由一行或多行文本组成,段落之间用空行分隔。段落内部的单个换行会被忽略——这些行会被合并在一起。要强制换行,请在行尾加两个空格或一个反斜杠:

markdown第一行末尾有两个空格  
第二行仍在同一个段落中。

空一行之后开始新的段落。

强调

输入 效果
*italic* 或 _italic_ italic
**bold** 或 __bold__ bold
***bold italic*** bold italic
~~strikethrough~~ strikethrough
`inline code` inline code

许多编辑器(包括 Markdown Preview Editor)还支持一些流行的扩展语法:==highlight== 高亮、H~2~O 下标、x^2^ 上标,以及 :smile: 这类表情短代码。它们并不属于 GFM 本身,使用前请先确认目标平台是否支持。

列表

无序列表使用 -、* 或 +,有序列表使用数字。缩进两到四个空格即可嵌套列表项。

markdown- 牛奶
- 面包
  - 全麦
  - 黑麦
- 咖啡

1. 克隆仓库
2. 安装依赖
3. 运行构建

有序列表不需要写对数字——每一行都写 1.,渲染出来仍然是 1、2、3。如果以其他数字开头(例如 5.),列表就会从那个数字开始编号。

任务列表

任务列表是 GFM 的扩展语法,可以把列表项变成复选框,非常适合 README、发布计划和会议记录。

markdown- [x] 撰写草稿
- [x] 添加截图
- [ ] 发布文章

链接

markdown[链接文字](https://example.com)
[带标题的链接](https://example.com "鼠标悬停时显示")
<https://example.com>

请阅读[安装指南][install]。

[install]: https://example.com/docs/install

最后一种写法是引用式链接:URL 只需在文档底部定义一次,这样长段落更易阅读。像 [Setup](docs/setup.md) 这样的相对链接指向同一项目中的其他文件;在 Markdown Preview Editor 中,如果目标文档已在另一个标签页中打开,点击链接就会切换到该文档。

图片

图片使用链接语法,只是前面多一个感叹号。方括号中的文字是替代文本——为看不到图片的人描述图片内容。

markdown![带实时预览的编辑器](images/screenshot.png)
![Logo](https://example.com/logo.svg "可选标题")

预览引用了本地图片的文档时,请打开整个文件夹,或把图片与 .md 文件一起拖入,这样预览工具才能解析相对路径。

代码

行内代码使用单个反引号。代码块则用三个反引号包裹,并加上语言名称以启用语法高亮:

markdown```js
function greet(name) {
  return `Hello, ${name}!`;
}
```

常用的语言名称:js、ts、python、bash、json、yaml、html、css、sql、go、rust、diff。如果代码本身包含三个反引号,就像上面的示例那样,用四个反引号把它包起来。

表格

用竖线分隔各列,并在表头下方加一行短横线。分隔行中的冒号用于设置对齐方式。

markdown| 功能 | 免费 | 说明           |
|:-----|:----:|---------------:|
| 预览 |  ✅  | 随输入即时更新 |
| 导出 |  ✅  | HTML, PDF, .md |

:--- 左对齐,:---: 居中,---: 右对齐。源码中的列不必对齐——不过好的编辑器会让它们保持整齐易读。Markdown Preview Editor 的工具栏中有一个表格按钮,可以插入现成的表格模板。

引用与提示框

在行首加上 > 即可引用文字。GitHub 还支持提示框(alerts)——第一行带有特殊标记的引用块,会渲染成彩色的提示框:

markdown> 一段普通的引用。

> [!NOTE]
> 用户应当了解的有用信息。

> [!TIP]
> 帮助你把事情做得更好的建议。

> [!WARNING]
> 需要立即关注的紧急信息。

提示框共有五种类型:NOTE、TIP、IMPORTANT、WARNING 和 CAUTION。请适度使用:每个章节一个提示框会很醒目,连用五个就成了干扰。

脚注

脚注能把旁注移出正文。脚注内容可以定义在任何位置,最终会显示在文档末尾。

markdownMarkdown 诞生于 2004 年。[^1]

[^1]: 由 John Gruber 创建,Aaron Swartz 参与协助。

分隔线与转义

单独一行写三个或以上的短横线、星号或下划线,就能生成分隔线:---。请在它前面留一个空行,否则紧跟在一行文字下面的 --- 会把那行文字变成标题。

如果想显示某个会被 Markdown 解析的字符,可以用反斜杠转义:\*not italic\*、\# not a heading、\$5(启用数学公式时很有用)。

数学公式与图表

在技术写作中,有两种扩展已成为标配:

Front matter 元数据

静态网站生成器会从文件最顶部的 YAML 块中读取元数据:

yaml---
title: My post
date: 2026-09-27
tags: [markdown, docs]
---

好的预览工具会隐藏这个块,而不是把它当作文本渲染出来。Markdown Preview Editor 正是这样做的。

下一步

掌握语法只是工作的一半——另一半是在写作时看到效果。请阅读如何在线预览 Markdown 而无需上传文件;文档完成后,再了解如何将 Markdown 转换为 HTML 或 PDF。

常见问题

Markdown 和 GitHub-Flavored Markdown 有什么区别?

最初的 Markdown(2004 年)定义了基础语法:标题、强调、列表、链接、图片、代码和引用。GitHub-Flavored Markdown 是基于 CommonMark 的严格规范,在此基础上增加了表格、任务列表、删除线、自动链接和脚注。大多数现代工具都遵循 GFM。

如何在 Markdown 中换行而不开始新段落?

在行尾加两个空格或一个反斜杠(\)。段落内的普通换行会被当作空格处理。

如何在 Markdown 中添加目录?

Markdown 没有内置的目录语法。您可以手动编写目录,用链接指向标题锚点,例如 [Tables](#tables)。许多工具会根据标题自动生成锚点,而 Markdown Preview Editor 的高级编辑器工具栏中有一个目录按钮,可以为您自动生成目录列表。

可以在 Markdown 中使用 HTML 吗?

许多渲染器允许使用部分 HTML,但各平台会移除任何可能不安全的内容,例如脚本和内联事件处理程序。为了让文档具有良好的可移植性,只要纯 Markdown 语法能表达您的需求,就优先使用它。