Markdown 速查表 — 语法与实时预览

一到六个 # 后跟一个空格。每个文档只用一个一级 # 标题，且不要跳级；屏幕阅读器和目录都依赖标题的层级顺序。

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

较早的 "setext" 写法，只支持一级和二级。段落下方的一行 --- 会把该段落变成标题，这常让想要分隔线的人意外：请在 --- 前空一行。

Heading 1
=========

Heading 2
---------

用空行分隔段落。段落内的单个换行会被合并成一行（“换行”中注明的情况除外）。

First paragraph, which can wrap
across several source lines.

Second paragraph after a blank line.

要换行但不另起段落，在行尾加两个空格或一个反斜杠。GitHub 评论、Obsidian（默认）、Slack 和 Discord 则把每个换行符都视为换行。

Two trailing spaces  
make a break.
A trailing backslash\
works too.<br>So does an HTML br.

星号在单词内部也有效，下划线则不行（snake_case_names 会保持原样），所以大多数风格指南推荐用 *。

**bold** or __bold__

*italic* or _italic_

***bold italic***

in**side**word works with *, not with _

每行以 > 开头。引用中可以包含任何其他 Markdown，包括列表和代码。

> Quoted text.
> Still quoted.
>
> > Nested quote.

-、* 和 + 都可以；同一列表中不要混用（换一种标记会开始一个新列表）。

- Item
- Item
  - Nested (indent 2 spaces)
- Item

第一个数字决定起始编号，后面的数字会被忽略，所以每行都写 "1." 的话，调整顺序后编号会自动更新。

1. First
1. Second
1. Third

3. Starts at three
4. Four

额外内容要缩进到与列表项文字的第一个字符对齐（"1. " 之后为 3 个空格）。

1. Install:

   ```sh
   npm install marked
   ```

2. Indent continuation lines
   to the item text.

反引号内的 Markdown 不会被解析。

Run `npm test` now.

Use ``double `backticks` `` when the code contains one.

单独成行的三个反引号（或 ~~~）。围栏后的单词指定语言，GitHub、GitLab、Obsidian 和 Discord 会据此进行语法高亮。

```js
const answer = 42;
console.log(answer);
```

const answer = 42;
console.log(answer);

最初的写法。围栏式更清晰，还能指定语言；但旧版 Reddit 只认缩进式代码。

Paragraph.

    four spaces of indent
    make a code block

four spaces of indent
make a code block

单独一行写三个或更多 -、* 或 _，上方留一个空行。

Above

---

Below (also *** or ___)

尖括号写法是 CommonMark 的自动链接。URL 中的空格必须写成 %20，或者把 URL 放在 <…> 中。

[Link text](https://freetoolsforweb.com)

[With a title](https://freetoolsforweb.com "Hover text")

[Relative link](/tools/regex-cheat-sheet)

<https://example.com>

让长 URL 不出现在正文里。定义可以放在文档中任意位置，且不会显示出来。

Read the [spec][cm] and the [GFM spec].

[cm]: https://spec.commonmark.org/
[GFM spec]: https://github.github.com/gfm/

在 GitHub 和 GitLab 上，每个标题都会自动生成 id：转为小写、空格变连字符、去掉标点（"## Install & Run" 会变成 #install--run）。Obsidian 则使用 [[#Heading]]。

[Jump to tables](#md-tables)

写法和链接一样，前面加 !。[ ] 中的文字是替代文本：为看不到图片的人描述图片内容。Markdown 没有设置尺寸的语法；在允许 HTML 的地方可以用 <img width="200">。

![Site logo](/brand/favicon.svg "Optional title")

[![Clickable image](/brand/favicon.svg)](/tools)

反斜杠可以让任何 ASCII 标点按字面显示：\ ` * _ { } [ ] ( ) # + - . ! |

\*not italic\*  \# not a heading  1\. not a list

CommonMark 允许使用。GitHub 和 GitLab 只保留安全的子集（不支持 script、style 和事件处理器）；Slack、Discord、Reddit 和 Notion 会把它显示为文本。

Press <kbd>Ctrl</kbd> + <kbd>C</kbd>, H<sub>2</sub>O, x<sup>2</sup>.

在允许 HTML 的地方，HTML 注释会保留在源码中，但不会显示。

Visible.

<!-- Not rendered: notes for editors -->

Also visible.

第二行必不可少；冒号用于设置对齐方式。源码中各列不必对齐。字面意义的竖线要转义为 \|。不支持合并单元格或多行单元格（在 GitHub 上可在单元格内使用 <br>）。

适用平台： GFM、GitLab、Obsidian、Reddit；Notion 在粘贴时转换

| Left | Centre | Right |
| :--- | :----: | ----: |
| a    |   b    |     1 |
| `c`  | **d**  |    22 |

在 GitHub 和 GitLab 的 issue 和拉取请求中，复选框可以直接点击，并会同步更新源码。

适用平台： GFM、GitLab、Obsidian；Notion 通过 [] 快捷语法

- [x] Write the draft
- [ ] Review
- [ ] Publish

通用写法是两个波浪号；GitHub 也接受一个。Slack 用 ~单个~ 波浪号，Jira 用 -连字符-。

适用平台： GFM、GitLab、Obsidian、Discord、Reddit、Notion

~~no longer true~~

GFM 会把裸 URL 和 www. 开头的地址自动转为链接。在标准 CommonMark 中，除非放在 <…> 中，否则它们仍是普通文本。

适用平台： GFM、GitLab、Obsidian、Slack、Discord、Reddit

Visit https://freetoolsforweb.com or www.example.com.

定义可以放在任意位置；脚注按引用顺序编号，并列在文末。Obsidian 还支持行内脚注：^[像这样]。

适用平台： GFM、GitLab、Obsidian（CommonMark 不支持）

Markdown was created in 2004.[^1]

[^1]: By John Gruber, with Aaron Swartz.

自己指定锚点。Pandoc、PHP Markdown Extra、Hugo、Jekyll（kramdown）、MkDocs 和 Docusaurus 支持；GitHub 和 GitLab 会忽略它并原样显示花括号，改用自动生成的 id。

适用平台： Pandoc、Hugo、Jekyll、MkDocs、Docusaurus；GitHub 和 GitLab 不支持

### Install {#setup}

用冒号包住的名称。在 GitHub、Slack、Discord 或 Notion 中输入冒号会弹出 emoji 选择器。直接粘贴 emoji 本身则在任何地方都有效。

适用平台： GitHub、GitLab、Slack、Discord；Obsidian（无插件时）和 CommonMark 不支持

Ship it :rocket: :+1: :tada:

行内公式把 TeX 写在 $ 之间，独立公式块用 $$。GitHub 还支持 $`…`$ 和 ```math 代码块；GitLab 支持同样的写法。Notion 用 $$…$$ 表示行内公式。

适用平台： GitHub、GitLab、Obsidian、Notion（自有语法）

Inline: $E = mc^2$

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

语言设为 mermaid 的代码块会渲染为图表：流程图、时序图、类图、状态图、甘特图和 ER 图。

适用平台： GitHub、GitLab、Obsidian、Notion（Mermaid 代码块）

```mermaid
flowchart LR
  A[Write] --> B{Review}
  B -->|ok| C[Publish]
  B -->|changes| A
```

GitHub 有五种类型：NOTE、TIP、IMPORTANT、WARNING、CAUTION。GitLab（17.10+）支持同样的语法。Obsidian 的类型更多，还支持自定义标题（> [!tip] Title）和折叠（> [!faq]-）。

适用平台： GitHub、GitLab 17.10+、Obsidian；其他地方显示为普通引用

> [!NOTE]
> Useful information.

> [!WARNING]
> Critical content that needs attention.

这是 HTML，但支持很广泛。内部的 Markdown 前后要留空行，否则不会被解析。

适用平台： GitHub、GitLab、Obsidian、大多数静态网站生成器

<details>
<summary>Click to expand</summary>

Hidden **Markdown** content.

</details>

Obsidian 和部分编辑器（Typora、iA Writer）支持；GitHub 会原样显示等号。在允许 HTML 的地方可用 <mark>。

适用平台： Obsidian、Typora；GitHub 不支持

This is ==highlighted== text.