Markdown 速查表

面向 GitHub、文档与 AI 写作的实用 Markdown 语法速查。覆盖 GFM 表格、任务列表、代码块,以及 MD Workbox 使用的公式与 Mermaid。

除非另有说明,本页处理均在浏览器本地完成。

清理杂乱 Markdown

Headings

Use one H1 per page when you can. ATX (#) style is the most portable.

语法含义示例
# Heading 1
Top-level heading

Heading 1

## Heading 2
Section heading

Heading 2

### Heading 3
Subsection

Heading 3

#### Heading 4
Minor heading

Heading 4

Emphasis

语法含义示例
**bold**
Bold

bold

__bold__
Bold (alternate)

bold

*italic*
Italic

italic

_italic_
Italic (alternate)

italic

***bold italic***
Bold + italic

bold italic

~~strike~~
Strikethrough (GFM)

strike

Lists

语法含义示例
- item
- item
Unordered list (-, * or +)
  • First
  • Second
  • Third
1. item
2. item
Ordered list
  1. First
  2. Second
  3. Third
- parent
  - child
Nested list (indent 2 spaces)
  • Parent
    • Child
    • Child

Task lists

GitHub-flavored Markdown checkboxes — useful for AI-generated action items.

语法含义示例
- [ ] todo
- [x] done
Unchecked / checked tasks

Code

语法含义示例
`code`
Inline code

Use pnpm dev to start.

```js
code
```
Fenced code block with language tag
console.log("hello")
```
plain
```
Fenced block without a language
plain text block

Quotes & rules

语法含义示例
> quoted text
Blockquote

Nothing you paste is uploaded.

> a
>> nested
Nested quote

Outer

Nested

---
Horizontal rule (***, --- or ___)

Above


Below

Tables

Header row + separator are required. Alignment uses `:---` / `---:` / `:---:`.

语法含义示例
| A | B |
| --- | --- |
| 1 | 2 |
Basic GFM table
Feature Status
Local Yes
Upload No
| L | C | R |
| :--- | :---: | ---: |
Left / center / right alignment
Left Center Right
a b c

Math formulas

Supported in MD Workbox Editor and converters (MathML or KaTeX). Also accepts \( \) and \[ \].

语法含义示例
$E = mc^2$
Inline math

Inline works here.

$$
\int_a^b f(x)\,dx
$$
Display math

Mermaid diagrams

Use a ```mermaid fence. Preview, HTML, PDF, DOCX and Image export render diagrams locally.

语法含义示例
```mermaid
flowchart LR
  A --> B
```
Flowchart (sequence, class, state, pie, … also work)
flowchart LR
  A[Paste] --> B[Preview]
  B --> C[Export]

Escaping

语法含义示例
\*not italic\*
Escape special characters with a backslash

*not italic* and `not code`

使用方法

  • 浏览左侧章节导航,或跳转到标题、表格、公式、Mermaid。
  • 点击任意语法格的「复制」,粘贴到编辑器或文档中。
  • 用「在编辑器中试示例」打开含公式与 Mermaid 图的样例。
  • 本参考遵循 GitHub 与多数静态站点生成器常用的 GFM 规则。

示例 Markdown

# Heading

**Bold** text and a [link](https://md.toolsworkbox.com)

`inline code`

常见问题

这些语法与 GitHub 兼容吗?

这里列出的日常写法(表格、任务列表、删除线、围栏代码)均兼容。MD Workbox 还支持预览与导出所用的公式定界符和 mermaid 代码块。

速查表和完整规范有何区别?

本页是写作者与开发者的快速参考,不是 CommonMark 规范全文。优先使用上方写法,便于在 GitHub、Notion 导出与 AI 输出间移植。

如何修复 ChatGPT 生成的坏 Markdown?

先粘贴到「清理 Markdown」规范化代码块与空行,再在编辑器中预览。

本页会上传内容吗?

不会。复制语法与渲染示例都在浏览器本地完成。打开编辑器也只保存本地草稿。

相关工具