MD

Markdown 语法速查

9 组 40+ 条 · 语法与效果对照 · 支持过滤

共 42 条

标题与段落

# 一级标题
整页只用一个,通常就是文章标题
一级标题
## 二级标题
正文章节的划分,多数目录按它生成
二级标题
###### 六级标题
# 越多越小,超过三级读者就开始迷路
六级标题
## 标题 ##
闭合式写法,尾部 # 可写可不写,去掉更干净
二级标题
空行分段
段落之间必须空一行,只换行会被合并成同一段
段一
段二

强调与行内

**加粗**
重点提示用,整段加粗等于没重点
加粗
*斜体*
术语、书名、外文词
斜体
***加粗斜体***
强调程度最高,一篇文章里别超过两处
加粗斜体
~~删除线~~
GFM 扩展语法,老解析器会原样显示波浪号
删除线
__加粗__ / _斜体_
与星号等价,但单词中间不生效,标识符多时用星号更稳
加粗 / 斜体
`行内代码`
函数名、参数、命令、文件名都该用它
行内代码
<kbd>Ctrl</kbd>
嵌 HTML 表示按键,GitHub 上显示成键帽
Ctrl

列表

- 无序项
- + * 三种符号等价,同一份文档里保持一致,- 最常用
  • 无序项
1. 有序项
数字写什么不重要,渲染时按出现顺序重排
  1. 有序项
3. 从任意数字开始
有序列表的起始编号会保留,写 3 就从 3 开始排
  1. 第三项
缩进两格嵌子项
子项前面空两到四个空格,空格数不统一会渲染错层
  • 父项
    • 子项
- [ ] 待办 / - [x] 完成
任务列表是 GFM 扩展,GitHub、Obsidian 支持
☐ 待办 ☑ 已完成

链接与图片

[文字](https://example.com)
最基本的行内链接,方括号是显示文字
[文字](url "标题")
引号里的内容鼠标悬停时显示
![替代文字](a.png)
感叹号开头是图片;方括号里是 alt,图片挂了就靠它
图片占位
[文字][id] + [id]: url
引用式链接,长 URL 集中写在文末,正文更干净
文字(id 在文末定义)
<https://example.com>
尖括号包住 URL 自动变链接,省掉方括号那一套
[跳到某节](#小节标题)
页内锚点,标题里的空格会变成连字符

代码

```js ... ```
围栏代码块,语言名决定高亮规则,不写也能渲染
const a = 1;
```diff ... ```
diff 高亮,+ 绿 - 红,贴补丁很好用
+ 新增
- 删除
外层用四个反引号
代码里要显示三个反引号时,外层多包一个就行
````
```
````
`` 代码里有反引号 ``
行内代码自身含反引号时,外层多包一个反引号
`a`

表格

| 列一 | 列二 |
表头下面必须有一行 ---,否则不认成表格
列一列二
值值
| :--- | ---: |
: 在哪边就往哪边对齐,两边都写是居中
左右
表格里换行
单元格内要换行得写 <br>,直接回车会把表格断掉
第一行
第二行
单元格里写 \|
竖线是列分隔符,内容里要出现就得转义
a | b → a \| b

引用与分割线

> 引用
引用块,常拿来放提示、摘录、注意事项
引用
> > 嵌套引用
多层引用,回复邮件时常见
嵌套引用
> 引用里放列表
引用块内可以继续写列表、代码块,符号跟着 > 一起缩进
  • 引用里的项
---
分割线。上一行不是空行时,它会被当成标题的下划线

转义与常见坑

\*星号转义
想显示语法符号本身,前面加反斜杠
*星号转义
中文标点后紧接 **
部分解析器不认,加个空格或改用 <strong> 才稳
「他说**好**」可能不生效
列表里嵌代码块
代码块要缩进八个空格(列表缩进 + 四格),少一格就散架
缩进 8 格

扩展语法

脚注 [^1]
文末自动生成注释区,学术引用和补充说明都用它
正文1
$E=mc^2$
数学公式,需要 KaTeX 或 MathJax 插件才渲染
E=mc²
```mermaid
流程图、时序图,需要渲染器支持 mermaid
(需插件)
[TOC]
自动生成目录,支持情况因渲染器而异
(需插件)

如何使用本工具

  1. 左边一列是语法,中间是说明,右边是渲染后长什么样,三列对着看最快。
  2. 搜索框支持按语法和说明双向过滤,比如搜「表格」或搜 `|` 都能定位到表格那一组。
  3. 写文档时优先用标准语法(标题、列表、链接、代码),扩展语法换渲染器就可能失效。
  4. 踩坑那组建议先扫一眼:中文标点紧贴星号、列表里嵌代码块,这两个是最常出问题的。

常见问题

Q:`*斜体*` 和 `_斜体_` 有区别吗?

A:渲染结果一样,但 `_` 不能用在单词中间——`snake_case_name` 不会变成斜体,而 `snake*case*name` 会。所以写代码标识符多的文档时,统一用 `*` 更安全。

Q:为什么我的表格不显示成表格?

A:九成是少了表头下面的分隔行。`| 列一 | 列二 |` 之后必须紧跟 `| --- | --- |`,否则就是普通文本。另外表格前后各留一个空行,否则某些解析器会把它吞进上一段。

Q:标题前后的空行要不要留?

A:要。ATX 标题(`#` 开头)虽然大多数解析器不严格要求,但紧贴上一段文字时,部分实现会把它当成普通文本。留一个空行是不出错的写法。

Q:代码块里能写反引号吗?

A:能,外层围栏多用几个反引号就行。比如要展示 ```` ```js ```` 这三个符号本身,就在外层用四个反引号包起来。

Q:为什么 `**加粗**` 有时候不生效?

A:常见于中文标点紧贴星号的情况,比如「他说**好**」。部分解析器要求强调符号内侧不能紧邻标点或汉字边界。稳妥做法是在星号外加空格,或直接写 `&lt;strong&gt;`。

Q:Markdown 能写 HTML 吗?

A:多数解析器允许内联 HTML,这也是 Markdown 的逃生舱:排版搞不定的地方直接写 `<div style="...">`。但有些平台(比如部分论坛、邮件模板)会在渲染前把 HTML 过滤掉,移植性会变差,能不用就不用。