判断 Markdown 是否适合当前文档,可以看三个条件:内容是否以文本为主、是否需要长期可读、是否会被多人编辑或版本管理。只要满足其中两项,使用 Markdown 通常比二进制格式和排版工具更稳。Markdown 的价值不在视觉装饰,而在结构稳定、可转换、可 diff。 一、先确定方言:CommonMark 还是 GFM 写作前先明确渲染环境。GitHub、GitLab、多数代码托管平台和 VS
判断 Markdown 代码块是否规范,主要看三点:是否使用围栏包裹、是否明确标注语言、围栏数量与缩进是否一致。日常写作优先使用围栏代码块;缩进代码块只在兼容旧解析器或处理极短纯文本时使用。 一、优先使用围栏代码块 围栏代码块用三个反引号 ```` ``` ```` 开始,三个反引号结束。开启围栏后同一行紧跟语言标识,例如: python def main(): print("hello