SuperAPI AI 工具集

markdown-validation

写作与研究

查看项目

更新于 10-15 17:21

技能介绍

用途:markdown-validation 用于校验 Markdown 文档文件,检查格式问题、语法错误、失效链接和质量标准,适合在编辑文档后、提交前或统一项目文档规范时使用。

主要能力:包含四类检查。语法校验:Markdown 语法是否有效、标题层级是否跳级、代码围栏是否闭合、列表格式与链接语法是否正确。链接校验:内部链接是否指向存在的文件、锚点链接是否匹配实际标题、网络可用时检查外部链接是否失效。格式规范:标题样式是否一致、代码块是否有语言标签、表格格式是否正确、是否有行尾空白、列表标记是否一致。文档质量:文件是否有描述性标题、代码示例是否完整、链接文字是否有描述性、表格是否有表头、需要时是否有正确的 frontmatter。

使用方式:可由 hooks 在 Markdown 文件编辑时自动触发校验。也可手动运行脚本:校验单个文件用 ./docs/skills/markdown-validation/scripts/validate-markdown.py path/to/file.md;校验多个文件在命令后依次列出 file1.md file2.md file3.md;校验目录用 find docs/ -name "*.md" -exec ./docs/skills/markdown-validation/scripts/validate-markdown.py {} +。输出为结构化结果,通过显示 PASS,失败显示 FAIL 并列出行号与问题,例如标题层级跳级、内部链接失效、代码围栏未闭合。

集成:可与 PostToolUse hooks 配合,在 Edit 或 Write 后自动校验 .md 文件。

配置:在项目根目录创建 .markdown-validation.json 可自定义校验,字段包括 checkLinks、checkSyntax、requireFrontmatter、allowedHeaderLevels、requireLanguageTags、maxLineLength。

限制:资料未说明支持的具体平台、安装方式、收费情况或性能表现;外部链接检查依赖网络可用性。