SuperAPI AI 工具集

markdown-linting

通用与其它

查看项目

更新于 10-16 00:23

技能介绍

用途:该技能提供使用 markdownlint-cli2 进行 Markdown 检查的指导,用于运行、执行、校验和修复 Markdown 文件,并在任意项目中统一文档质量规范。主要能力:支持检查全部 Markdown 文件、自动修复可修复问题、处理 MD0XX 规则错误、配置 .markdownlint-cli2.jsonc、设置 VS Code 扩展与 GitHub Actions 集成、排查常见问题。使用方式:零配置可用 npx markdownlint-cli2 "/*.md" 检查,用 npx markdownlint-cli2 "/*.md" --fix 自动修复;若已配置则可运行 npm run lint:md 与 npm run lint:md:fix。本地安装采用 npm install,配置写入仓库根目录的 .markdownlint-cli2.jsonc,作为 VS Code、CLI、CI 的统一来源。适用场景:GitHub 仓库、常规 Web 项目,默认校验 GitHub Flavored Markdown;也可选择 CommonMark 以提高可移植性。限制与要求:需要 Node.js 环境(资料中 npx 路线为 Node.js 18+,从零配置路线要求 Node.js 20+);不得在未获批准时修改 .markdownlint-cli2.jsonc,出现错误应修改内容而非放宽规则;严禁用脚本批量修复 Markdown,脚本无法识别嵌套代码块、原始输出等语义,只能在人工逐条审核下用编辑工具定点修复,--fix 仅用于安全的内置自动修复。官方链接、收录来源等信息暂未提供。