第 3 课
GitHub Flavored Markdown
使用 GFM 表格、围栏代码块、任务列表等 GitHub 友好扩展。
GitHub Flavored Markdown（GFM）在基础 Markdown 之上扩展了 README 与 Issue 中常用的能力。
表格
| 工具 | 用途 |
| --- | --- |
| JSON Formatter | 校验 API 载荷 |
| Markdown Preview | 编写 README 草稿 |
表格适合功能清单、兼容性矩阵和快速对比。
带语言标识的围栏代码块
```json
{
"status": "ok"
}
```
语言标识有助于渲染器做语法高亮，也能让读者一眼看出片段类型。
任务列表
- [x] 新增接口
- [ ] 更新文档
- [ ] 补充回归测试
任务列表常见于 Issue 模板和 PR 检查清单。
删除线
~~已废弃选项~~
适合记录已移除的配置项或废弃 API 字段。
GFM 并非处处等价
并不是所有 Markdown 渲染器都支持全部 GFM 特性。发布前建议：
- 确认目标平台支持表格和任务列表
- 若文档要在多个系统渲染，避免依赖过于小众的扩展
关键结论
GFM 是大多数 GitHub README 与 Issue 内容背后的方言。若主要面向 GitHub 写作，表格、围栏代码块和任务列表通常是安全选择。
提交 README 或 Issue 模板前，可先在 Markdown 预览 / Markdown 转 HTML 工具 中预览 GFM 样例。