文档 / Markdown 语法指南

Markdown 语法指南

发布于 更新于 查看 Markdown 原文

墨流渲染 GitHub 风格 Markdown,并支持 KaTeX 数学公式与代码语法高亮。本指南按语法逐个讲解,每个都附可复制的示例。

标题

行首写 1–6 个 # 加一个空格。标题会自动生成目录面板,本站的目录也由此而来。

强调

markdown
**粗体**  *斜体*  ~~删除线~~  `行内代码`

渲染效果:粗体、斜体、删除线、行内代码。

列表

无序与有序

markdown
- 第一项
- 第二项
  - 嵌套项

1. 第一步
2. 第二步

任务列表

markdown
- [x] 已发布功能
- [ ] 补写文档
  • 已发布功能
  • 补写文档

表格

分隔行里的冒号控制对齐方式:

markdown
| 功能 | 快捷键 | 状态 |
| :--- | :---: | ---: |
| 查找替换 | Ctrl / ⌘ + H | 可用 |
| 专注模式 | Ctrl / ⌘ + Shift + F | 可用 |

代码块

围栏后标注语言即可获得高亮:

markdown
```ts
type Writer = {
  name: string;
  published: number;
};

const writer: Writer = { name: '墨流', published: 12 };
console.log(`你好,${writer.name}`);
```

数学公式

行内公式用单 $...$,独立公式用 $$...$$:

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

行内示例:著名的 E=mc2E = mc^2。

引用与提示框

markdown
> 一段值得保留的话。

一段值得保留的话。

也支持 GitHub 风格的提示框:

markdown
> [!TIP]
> 导出功能可以下载 Markdown、独立 HTML,或直接打印成 PDF。
提示

导出功能可以下载 Markdown、独立 HTML,或直接打印成 PDF。

流程图(Mermaid)

graph TD A[开始写作] --> B{是否使用模板?} B -- 是 --> C[从模板中心新建] B -- 否 --> D[白纸开始] C --> E[享受实时预览] D --> E

用 ```mermaid 围栏即可渲染流程图、时序图等图表(见上图)。

链接与锚点

标准链接照常使用——[文字](https://example.com)。以 # 开头的链接会在当前文档内跳转到对应标题,例如回到标题。

哪些语法不被支持

默认情况下,Markdown 中的原始 HTML 不会被渲染(脚本与未知标签会被移除以保证预览安全)。如需允许白名单 HTML,可在「偏好设置 → 编辑行为 → 渲染安全 HTML」中开启。