Markdown 语法指南

一份清晰的日常 Markdown 速查表，每个模块都展示语法与最终效果。

什么是 Markdown？

Markdown 是一种为纯文本添加格式的轻量方式。你无需按钮和菜单，只需使用几个简单的符号，比如用 # 表示标题、用 * 表示强调，即使作为原始文本也依然清晰易读。

Markdown 由 John Gruber 和 Aaron Swartz 于 2004 年创建，如今已成为 README、文档、笔记以及 GitHub、Reddit 等网站的通用标准。因为它本质上只是文本，你的内容在任何地方都能便携且易读。

本指南涵盖了你最常用到的语法。在 Markdown Peek 中打开任意示例，按空格键即可在原始文本和渲染效果之间切换。

标题

在行首使用一到六个 # 字符。井号越多，标题级别越小、层级越深。

Markdown

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

效果

Heading 1

Heading 2

Heading 3

Heading 4

粗体、斜体等

用符号包裹文字即可添加强调效果，还可以自由组合。

Markdown

**Bold text**
*Italic text*
***Bold and italic***
~~Strikethrough~~
`Inline code`

效果

Bold text

Italic text

Bold and italic

~~Strikethrough~~

Inline code

列表

用短横线、星号或加号表示无序列表项目符号，用数字表示有序列表，缩进即可嵌套。

Markdown

- First item
- Second item
  - Nested item
- Third item

1. Step one
2. Step two

效果

First item
Second item
- Nested item
Third item

Step one
Step two

链接

将显示文字放在方括号中，将地址放在圆括号中。

Markdown

[Markdown Peek](https://markdownpeek.com)
<https://markdownpeek.com>

效果

Markdown Peek

https://markdownpeek.com

图片

图片就是在链接前加一个感叹号，方括号中的文字即为替代文本。

Markdown

![A cat looking up](cat.jpg)

效果

引用块

在行首使用 > 即可引用该行，再加一个 > 可以在引用中嵌套引用。

Markdown

> A quote worth remembering.
>
> > And a nested one.

效果

A quote worth remembering.
And a nested one.

代码

用单个反引号包裹行内代码，用三个反引号包裹整段代码块，并可选择性地指定语言名称。

Markdown

Use `backticks` for inline code.

```js
function hi() {
  console.log("Hello");
}
```

效果

Use backticks for inline code.

function hi() {
  console.log("Hello");
}

表格

用竖线分隔列，用短横线为表头行加下划线，冒号用于设置对齐方式。

Markdown

| Feature | Supported |
|---------|:---------:|
| Tables  | Yes       |
| Code    | Yes       |

效果

Feature	Supported
Tables	Yes
Code	Yes

水平分割线

在独立一行中使用三个或以上的短横线、星号或下划线，即可绘制出一条分割线。

Markdown

Above the line.

---

Below the line.

效果

Above the line.

Below the line.

任务列表

使用 [ ] 的列表项表示未完成的任务，[x] 表示已完成的任务。

Markdown

- [x] Read the guide
- [ ] Set as default app

效果

Read the guide
Set as default app

转义字符

在符号前加一个反斜杠，即可让它以原样显示，而不被解析为格式。

Markdown

\*Not italic\*
\# Not a heading

效果

*Not italic*

# Not a heading

使用 LaTeX 书写数学公式

用单个美元符号包裹 LaTeX 可在句中插入行内公式，用两个美元符号包裹则可在独立一行显示公式。Markdown Peek 会离线渲染这两种形式。

Markdown

Inline math like $E = mc^2$ works in a sentence.

$$
a^2 + b^2 = c^2
$$

效果

Inline math like E = mc² works in a sentence.

a 2 + b 2 = c 2

使用 Mermaid 绘制图表

使用 mermaid 开启一个围栏代码块，用纯文本描述流程图或时序图。Markdown Peek 会为你绘制出来，并适配浅色或深色模式。

Markdown

```mermaid
flowchart LR
  A[Write] --> B[Preview]
  B --> C[Share]
```

效果

在 Mac 上优雅地阅读 Markdown

Markdown Peek 以简洁的 GitHub 风格渲染任意 .md 文件，支持访达中的快速查看，并可存为 PDF。在 Mac App Store 上免费下载。