第 6 课
Markdown 写作流程
发布前检查标题结构、链接、表格和常见 Markdown 错误。
在把 Markdown 发布到 GitHub、文档仓库或 CMS 字段之前,建议做一次简短检查。
实用流程
- 用 Markdown 起草文档。
- 预览渲染结果。
- 检查标题结构是否有跳级或缺失章节。
- 检查链接列表里是否有 broken link 或占位 URL。
- 确认表格、代码块和任务列表渲染正常。
- 面向 Git 场景复制 Markdown;面向 CMS/邮件场景复制 HTML。
常见 Markdown 错误
- 标题跳级:从
#直接到###,中间缺少## - 列表格式问题:某些渲染器要求在列表前留空行
- 围栏代码块未闭合:忘记结尾的 ```
- 表格列数不一致:行内字段数量对不上
- 占位链接:最终文档仍保留
https://example.com - 过度使用 HTML:本可用 Markdown 语法表达的内容却手写 HTML
结构比样式更重要
Markdown 质量主要取决于:
- 便于扫读的标题
- 简短段落
- 明确链接
- 可用的代码样例
- 与数据形状匹配的表格
预览主题颜色不会随文档一起发布,但结构会。
关键结论
把 Markdown 评审当作轻量文档 QA:先预览,再查结构,再验链接,最后按目标系统选择导出格式。
Markdown 预览 / Markdown 转 HTML 工具 在同一工作区提供实时预览、标题结构、链接列表和复制操作,适合这套流程。