Markdown速查表

步 1 / 3 33%

选择一个Markdown主题

先查看一组示例,然后打开完整速查表。

常用Markdown语法按主题整理,并将可复制源码与真实解析器的输出并排展示。内容涵盖CommonMark基础语法(标题、列表、强调、链接、图片和围栏代码块)以及GitHub Flavored Markdown扩展(表格、任务列表、删除线和普通URL自动链接)。使用GitHub、GitLab、Obsidian或静态网站生成器时,可以随时查阅。

如何使用该速查表

  1. 1

    按类别浏览

    跳转至标题、列表、代码、链接、表格或GFM扩展功能。

  2. 2

    对比源码与结果

    每个示例都会并排显示原始Markdown与真实GFM解析器的输出。

  3. 3

    复制代码片段

    点击“复制”即可获取任意示例的源代码。

  4. 4

    查看语法标签

    每个示例都会标注为CommonMark或GitHub Flavored Markdown(GFM)。

标题

# H1 标题
## H2 章节
### H3 小节

请使用ATX格式(#),而非Setext格式(在文本下方加===)。虽然所有解析器都支持这两种格式,但在代码差异对比中ATX格式更易阅读。

强调

*斜体*_斜体_**加粗**__加粗__***加粗斜体***。GFM新增了 ~~删除线~~

列表

无序列表使用 -*+(选择其一并统一使用):

- 第一项
- 第二项
  - 嵌套(两个空格)

有序列表会自动重新编号:

1. 列表项
1. 列表项
1. 列表项

代码

行内: `code` 。带可选语言标签的围栏代码块:

```python
def hello(name):
    return f"你好,{name}"
```

如果你偏好旧版语法,可在代码块前缩进四个空格。

链接和图片

[链接文本](https://example.com)
[带标题的链接](https://example.com "提示")
![替代文本](/path/to/image.png)

引用式写法可避免长URL出现在段落中:

参见[文档][1]。

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

表格(GFM)

| Col A | Col B |
|-------|------:|
| a     |     1 |
| b     |    22 |

对齐方式在分隔行中使用冒号::--- 左对齐,:---: 居中,---: 右对齐。

任务列表(GFM)

- [x] 已完成
- [ ] 待办

常见陷阱

  • 行尾两个空格可在段落内插入换行;一个空格仅将两行连接起来。
  • 大多数块级元素(标题、列表、代码块)之前都需要一个空行
  • 如果渲染器需要空格,请不要用制表符缩进列表标记;应使用两个或四个空格缩进。
  • 使用反斜杠转义可显示字面标点:\*不是斜体\*
  • 智能引号因渲染器而异:GitHub保持原样,Pandoc则会转换。

常见问题

CommonMark定义了可移植的核心语法,包括标题、列表、链接以及可带可选信息字符串的围栏代码块。GFM增加了表格、任务列表、删除线和普通URL自动链接。其他编辑器可能只支持其中一部分,或加入自己的扩展。

Markdown会把单个换行符视为空格。若要插入 <br>,请在行尾加两个空格;在GFM中也可在行尾使用 \

在大多数解析器中可以,块级HTML标签会被原样传递。部分渲染器会对其进行净化处理(例如GitHub会移除内联脚本和事件属性)。

CommonMark没有内置目录语法。GitHub会创建标题锚点,并为包含多个标题的文件显示大纲。其他平台各有规则:启用相应扩展后,MkDocs可以使用 [TOC];Docusaurus则根据标题生成页面目录。

CommonMark和GFM规则都适用。不过Obsidian还新增了维基链接([[页面名称]])、标注框(callout)以及嵌入块等Obsidian专属功能,这些内容不在本速查表之中。

相关工具