用途:帮助写作者在首次撰写 Markdown 时就符合常见 lint 规则,减少“编辑—检查—修复”的循环。核心原则是“拿不准就加空行”,因为多数 lint 错误来自缺少空行。
主要能力:整理常见规则速查,包括列表前后空行(MD032)、围栏代码块前后空行(MD031)、标题前空行(MD022)、无序列表使用短横线(MD004)、行尾无多余空格(MD009)、文件末尾单个换行(MD047)、围栏代码块标注语言(MD040)、统一围栏风格(MD046)、不用加粗代替标题(MD036)、表格分隔行管道符间距(MD060)。还包含 Mermaid 相关规则:模板块用 text 而非 mermaid;%%{init}%% 后必须紧跟图表类型;不能嵌套围栏代码块,需用行内代码或描述替代。
使用方式:写作前按清单自查——是否有列表、代码块、错误示例、表格、Mermaid;对应检查空行、围栏、分隔行与图表类型。资料未提供安装命令或具体调用方式。
适用场景:撰写 README、文档、注释等 Markdown 内容,尤其适合需要持续通过 lint 检查的项目。
限制:资料未说明支持的 lint 工具、平台或版本;规则以常见 lint 规则为准,具体行为可能因工具配置而异。