SuperAPI AI 工具集

lint-clean-markdown

通用与其它

查看项目

更新于 10-15 21:40

技能介绍

用途:在编写或评审 Markdown 文件时,提前规避常见 markdownlint 报错,减少编辑—检查—修复的循环。适用于撰写文档、评审涉及 .md 文件的 PR,或文件刚触发 MD031、MD032、MD022、MD060 等错误时。

主要能力:以速查表形式归纳核心规则,包括列表前后空行(MD032)、代码围栏前后空行(MD031)、标题前空行(MD022)、无序列表用短横线(MD004)、行尾无空格(MD009)、文件末尾单个换行(MD047)、围栏标注语言(MD040)、围栏风格一致(MD046)、不用加粗当标题(MD036)、表格分隔符间距(MD060)。核心原则是“拿不准就加空行”,约九成错误源于缺少空行。

使用方式:写作前按清单规划——有列表则前后留空行,有代码块则前后留空行,有表格则需分隔行,有 mermaid 则首行声明图表类型。正文中需要强制换行时,用行尾反斜杠加换行(CommonMark 硬换行),而非两个尾随空格或 <br/>。

限制:Markdown 不支持嵌套围栏代码块,展示“错误示例”时需改用行内代码或文字描述;模板/占位内容应使用 text 而非 mermaid 围栏;表格单元格内换行用 <br/>。资料未提供安装命令、收费或平台信息。