Markdown速查表:全部21个语法元素一页看全
Markdown速查表是一份单页参考,把每个Markdown元素和对应的准确语法放在一起,让你不用翻阅完整文档就能完成排版。 本页用两张表格覆盖全部21个元素:John Gruber在2004年原始规范中定义的10个基础元素,以及CommonMark(2014)和GitHub Flavored Markdown(2017)等后来的变体在此基础上新增的11个扩展元素。本页的每个语法示例都可以在在线Markdown编辑器中直接使用,实时预览会在你输入的同时显示渲染结果。
基础语法
基础语法涵盖2004年Markdown原始设计中的10个元素,所有Markdown应用对它们的渲染结果完全一致。 这10个元素足以应对日常写作的绝大部分需求:结构靠标题和列表,强调靠加粗和斜体,引用靠链接和图片。如果一份文档只用到这张表格里的行,它在GitHub、Obsidian、Reddit、Discord以及2004年之后诞生的任何编辑器中都能正确渲染。
| 元素 | Syntax | 渲染结果 |
|---|---|---|
| 标题 | # H1 / ## H2 / ### H3 | 1至6级的章节标题;每级对应一个# |
| 加粗 | **strong words** | strong words |
| 斜体 | *slanted words* | slanted words |
| 引用块 | > quoted line | 带左侧边线的缩进引用块 |
| 有序列表 | 1. Step one 2. Step two | 编号列表;编号按顺序渲染 |
| 无序列表 | - First point - Second point | 项目符号列表;*和+也可以作为标记 |
| 代码 | `inline code` | 等宽代码框中的inline code |
| 分隔线 | --- | 用于分隔章节的通栏分隔线 |
| 链接 | [anchor text](https://example.com) | 可点击的超链接,链接文字为“anchor text” |
| 图片 |  | 嵌入的图片,带无障碍替代文本 |
标题标记在最后一个#之后需要一个空格,分隔线上方需要空一行。大多数基础语法的渲染失败都源于这两个细节。
扩展语法
扩展语法新增了11个2004年原始规范从未包含的元素,能否支持取决于应用实现的是哪种Markdown变体。 表格、围栏代码块和任务列表随GitHub Flavored Markdown出现,GitHub在2017年将其正式定为规范。脚注、定义列表和高亮来自其他变体,支持它们的应用更少。
| 元素 | Syntax | 渲染结果 |
|---|---|---|
| 表格 | | Name | Role | | --- | --- | | Ada | Engineer | | 带表头行、列对齐的网格 |
| 围栏代码块 | ```json { "id": 1 } ``` | 多行代码框,可选语法着色 |
| 脚注 | A claim.[^1] [^1]: The source. | 编号引用,注释显示在页面底部 |
| 标题ID | ## Pricing {#pricing} | 带自定义锚点的标题,便于直接链接 |
| 定义列表 | Term : Meaning of the term | 术语占一行,定义缩进显示在下方 |
| 删除线 | ~~old figure~~ | |
| 任务列表 | - [x] Ship the draft - [ ] Review edits | 带已勾选与未勾选方框的清单 |
| Emoji短代码 | :tada: | 对应的emoji字符,🎉 |
| 高亮 | ==key phrase== | 带彩色背景的文字 |
| 下标 | H~2~O | H₂O |
| 上标 | x^2^ | x² |
各应用的支持情况不同:GitHub渲染表格、围栏代码块、任务列表、删除线、脚注和emoji短代码,但忽略高亮、下标和上标;Obsidian支持表格、脚注、任务列表、删除线和高亮;Discord接受加粗、斜体、删除线和代码块,但不支持表格和脚注。当目标平台未知时,10个基础元素是最稳妥的选择。
如何使用这份速查表
在左列找到元素,从中间一列复制语法,再把占位文字替换成你自己的内容。 渲染结果一列展示输出效果,你可以在复制前确认该元素符合预期。扩展表格中的任何元素,请先查看支持说明;在GitHub上能正常渲染的脚注,到了Discord就会消失。
验证语法最快的方式是把它粘贴进在线Markdown编辑器。实时预览会在几毫秒内渲染每个元素,表格写错或**标记没有闭合都会立刻显现。每天使用Markdown的写作者通常一周内就能记住基础表;扩展表才是值得放在手边的部分,也是这份Markdown语法表最常被翻到的地方。
下载与打印
这份速查表可放进一张A4纸,并提供.md文件版本,你可以把它存进自己的笔记应用,或打印出来放在桌上当Markdown备忘单。 下载的文件本身就是有效的Markdown,两张表格在任何支持GFM表格的应用中都能正确渲染。在编辑器、Obsidian或GitHub仓库中打开它,这份参考依然保持排版。
常见问题
Markdown基础语法和扩展语法有什么区别?
基础语法指2004年原始规范中的10个元素,扩展语法指后来的变体新增的11个元素。 所有Markdown应用都支持基础集合。扩展集合取决于变体:CommonMark在2014年标准化了核心行为,GFM在2017年的规范中加入了表格、任务列表和删除线。
所有Markdown应用都支持扩展语法吗?
不是。扩展语法的支持情况因应用而异,没有任何一款应用能渲染全部11个扩展元素。 GitHub不支持高亮和下标,Discord不支持表格和脚注,Obsidian在三者中覆盖范围最广。面向多平台发布的文档应以基础语法加GFM表格为准。
Markdown难学吗?
不难。Markdown一共只有21个元素,其中10个基础元素就能覆盖大多数文档。 标题用#、加粗用**、列表用-,这三样就占了实际使用的大部分。大多数人在带实时预览的编辑器里练习一次就能流畅书写Markdown,因为预览会当场纠正错误。
