跳到正文

我所理解的 Markdown 最佳实践

一篇技术文档通常要经过几次交接。作者在编辑器里写,读者在网页上看,有人把示例复制到项目里,审阅者再把意见交回给作者。Markdown 让这些人可以围绕同一份文本工作,也让解析、检查和批注各有了自己的边界。

由于篇幅问题,全文分成六部分来讲。

第一篇《中文加粗为什么会露出星号》从露在页面上的双星号说起,看看中文标点怎样影响 CommonMark 的强调边界。

第二篇《给 Markdown 文档接入 textlint》把术语、异常字符和中文加粗的问题放进写作检查,说明 textlint 怎样给出行号和反馈。

第三篇《Markdown 里的代码也要检查》讨论 CSS、TypeScript 和 Vue 围栏怎样复用源码的格式与 lint 规则,以及什么时候需要实际编译。

第四篇《给 AI 写的 Markdown 做批注》把审阅意见写在可定位的原文旁边,说明 CriticMarkup 和 MarkMark 怎样进入人与 Agent 的协作流程。

第五篇《Markdown 怎样交付到网页和富文本编辑器》比较交付 Markdown、生成静态 HTML 和粘贴到富文本编辑器时,语法、图片与代码块会经过哪些处理。

第六篇《善用 Markdown 扩展语法》用提示框、脚注、折叠、公式和双链对照各平台的写法,再说明怎样给自己的渲染器选择解析库和扩展。