Primary navigation
简体中文

Markdown 实用指南

实用 Markdown 排版指南

了解如何编写标题、表格、代码、图片、公式、Mermaid 图表和元数据,让 Markdown 更稳定地转换为 Word、PDF 与独立 HTML。

先保证结构

适合 Word DOCX、PDF、HTML 的 Markdown 结构

先使用清晰、明确的结构;模板再为所选 Word DOCX、PDF、HTML 添加视觉规则。

H1–H6

标题与层级

使用一个文档标题,再按层级顺序使用小标题。启用自动编号时,不要在标题文字里重复手写编号。

# Project brief · ## Decision summary
TABLE

结构清楚的表格

普通数据使用管道表格;单元格需要多段内容或支持的跨行跨列时,使用网格表格。

| Owner | Status | · | --- | --- |
CODE

保持可读的代码

使用带语言标签的围栏代码块;技术模板还可以保留文件名和行号设置。

```js · const ready = true; · ```
ASSET

图片与图表

本地图片使用相对路径并与 Markdown 一起打包。Mermaid 图表会在提交任务前由浏览器生成。

![Review flow](assets/flow.png)
MATH

公式与引用

公式使用受支持的 TeX 定界符;图、表或公式需要交叉引用时,使用稳定标识。

Inline: $E = mc^2$
META

正文前的元数据

YAML front matter 可为文档封面和设置提供标题、副标题、作者、日期、摘要和关键词。

--- · title: Project brief · ---

转换前检查

修改源内容前,先检查这些项目。

点击转换前,先让源内容可检查,并明确最终需要的输出格式。

  1. 01确认第一个标题是文档标题。
  2. 02检查本地资源、表格宽度和超长公式。
  3. 03选择符合交付场景的 Word DOCX、PDF、HTML。
  4. 04在目标应用中打开下载文件。