标题和段落
用一至六个井号作为标题前缀。使用一个 H1 作为文档标题,然后逐级向下,不要仅凭视觉大小选择标题级别。段落之间用空行分隔。
# Document title An opening paragraph. ## Installation Setup details. ### Environment variables Configuration details.
强调、链接和图片
用星号表示强调,用方括号包裹可见的链接文字,用圆括号标明目标地址。图片语法多一个感叹号;当图片无法显示时,有意义的替代文本仍然很重要。
Use **bold** for strong importance and *italic* for emphasis. Read the [deployment guide](/guides/deploy). 
列表和任务列表
无序列表项以连字符开头,有序列表项以数字开头。嵌套项要保持一致的缩进。许多开发者平台还通过 GitHub Flavored Markdown 支持任务列表复选框。
- Prepare the release - Update the changelog - Freeze migrations - Deploy 1. Start the canary 2. Watch metrics 3. Expand traffic - [x] Tests pass - [ ] Docs reviewed
行内代码和围栏代码块
用单个反引号包裹简短的标识符或命令。把较长的示例放在三重反引号围栏之间,并在渲染器支持语法高亮时添加语言名称。可执行的示例要保持足够完整,便于理解和测试。
Set `SERVICE_URL` in the server environment.
```ts
type Result = {
markdown: string;
fileName: string;
};
```引用块、分隔线和表格
引用块适合引用的内容或简短的提示。水平线用来分隔主要章节的过渡。表格适合紧凑、矩形的数据;当单元格包含长文本或表格过宽时,就会变得难以阅读。
> Conversion preserves structure, not pixel-perfect layout. --- | Format | Good for | Review | | --- | --- | --- | | DOCX | Styled prose | Tables | | CSV | Small datasets | Escaping |
编写可在不同渲染器中正常工作的语法
在标题、列表、表格和围栏代码块周围留出空行。尽量使用描述性链接而不是裸 URL。除非发布系统明确支持并净化原始 HTML,否则避免使用。当某个特性是平台专属的,请包含足够的纯文本,让文档在其他地方仍能读得通。