在线 Markdown 预览工具让你在一侧写 Markdown,另一侧实时看到 HTML 渲染结果——无需配置编辑器,无需构建步骤,无需浏览器插件。粘贴 README 草稿、博客文章或文档片段,提交前先确认渲染效果。

立即使用 Markdown 预览工具 →

Markdown 是什么?

Markdown 是 John Gruber 于 2004 年创建的轻量标记语言,用纯文本语法生成 HTML——**粗体** 变成粗体,# 标题 变成 <h1>,以此类推。设计目标:源文本可读,渲染结果干净。

Markdown 的应用场景几乎无处不在:

  • GitHub README 和 PR 描述
  • 文档站点(Docusaurus、MkDocs、VitePress)
  • 静态站点生成器(Astro、Hugo、Jekyll)
  • 笔记工具(Obsidian、Notion、Bear)
  • API 文档(Swagger 描述、Postman collection)

GitHub Flavored Markdown(GFM)

最广泛使用的 Markdown 方言是 GitHub Flavored Markdown(GFM),它在 CommonMark 规范基础上增加了开发者常用特性:

表格

| 方法   | 路径            | 说明         |
|--------|-----------------|--------------|
| GET    | /users          | 获取用户列表 |
| POST   | /users          | 创建用户     |
| DELETE | /users/{id}     | 删除用户     |

支持列对齐(:--- 左对齐、:---: 居中、---: 右对齐),渲染为标准 HTML 表格。

任务列表

- [x] 搭建 CI 流水线
- [x] 编写单元测试
- [ ] 添加集成测试
- [ ] 部署到预发环境

GitHub 在 issue 和 PR 中将这些渲染为可交互的复选框。

带语法高亮的代码块

```javascript
async function fetchUser(id) {
  const res = await fetch(`/api/users/${id}`);
  if (!res.ok) throw new Error(`HTTP ${res.status}`);
  return res.json();
}
```

开头三反引号后跟语言标识符(javascriptpythongobash 等),大多数渲染器会触发语法高亮。

删除线

~~废弃的 API~~ → 请使用 `/v2/users`

自动链接

GFM 自动将裸 URL 转换为可点击链接,无需手动写 [文字](url) 语法。

Markdown 核心语法速查

标题

# 一级标题
## 二级标题
### 三级标题
#### 四级标题

强调

**粗体**
*斜体*
***粗斜体***
`行内代码`

链接与图片

[链接文字](https://example.com)
[带标题的链接](https://example.com "悬停提示")
![图片描述](image.png)

列表

- 无序列表项
- 另一项
  - 子项(缩进 2 个空格)

1. 第一项
2. 第二项
3. 第三项

引用块

> 这是一段引用。
>
> 可以跨越多个段落。
>> 嵌套引用

分隔线

---
***
___

内嵌 HTML

Markdown 直接透传原始 HTML,可以用于 Markdown 无法表达的场景:

<details>
<summary>点击展开</summary>

隐藏内容在这里。

</details>

典型应用场景

README 文件

结构良好的 README 通常包含:

# 项目名称

简短说明这个项目做什么。

## 安装

```bash
npm install my-package

使用方法

import { myFn } from 'my-package';
myFn({ option: true });

API 参数

参数类型默认值说明
debugbooleanfalse开启调试日志
timeoutnumber5000请求超时(ms)

许可证

MIT


### 接口文档

在引入 OpenAPI 之前,Markdown 是记录 REST 接口的理想选择:

```markdown
## POST /auth/token

用凭据换取 JWT 访问令牌。

**请求体**

```json
{
  "email": "user@example.com",
  "password": "secret"
}

响应 200

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresIn": 3600
}

响应 401 — 凭据无效。


### 更新日志

Keep a Changelog 格式使用 Markdown:

```markdown
## [2.1.0] — 2026-03-15

### 新增
- 深色模式支持
- 快速搜索快捷键(Cmd+K)

### 修复
- Windows 换行符标准化问题 (#234)
- WebSocket 处理器内存泄漏 (#241)

### 废弃
- `legacyAuth()` — 请改用 `authenticate()`

Markdown 方言对比

方言使用场景扩展特性
CommonMark通用基准严格规范,行为一致
GFMGitHub、GitLab、Gitea表格、任务列表、自动链接
MDXReact/Astro 站点Markdown 中嵌入 JSX 组件
MultiMarkdown学术写作脚注、文献引用
Pandoc Markdown文档转换LaTeX 公式、引用

对于大多数开发者内容,GFM 是正确的选择。对于静态站点,MDX 提供完整的组件能力。

Markdown 写作技巧

保持标题层级连续 — 不要跳级(不要从 H1 直接跳到 H3)。屏幕阅读器和文档生成工具依赖标题树。

块级元素前后留空行 — 在标题、代码块、列表和引用块前后各加一个空行。部分解析器在缺少空行时渲染结果不正确。

优先使用围栏式代码块 — 四空格缩进代码在嵌套列表中容易产生歧义。带语言标识的围栏式代码块(三反引号)含义明确,且支持语法高亮。

对重复 URL 使用引用链接 — 避免在文中多次重复同一个长 URL:

详情参见 [MDN 文档][mdn]。
[MDN][mdn] 网站也有相关教程。

[mdn]: https://developer.mozilla.org

避免用行尾空格换行 — 行尾两个空格换行(行内容 \n)不可见,容易出错。改用 <br> 或重新组织段落。

立即预览你的 Markdown

ZeroTool 的 Markdown 预览工具支持 GitHub Flavored Markdown 实时渲染,带完整语法高亮。粘贴内容,即时看到效果——无需注册,全程本地处理,数据不离开浏览器。

打开 Markdown 预览工具 →