SuperAPI AI 工具集

markdownlint

通用与其它

查看项目

更新于 10-16 06:20

技能介绍

用途:对 Markdown 文件进行风格与一致性检查,基于 markdownlint-cli2 命令行工具。适用于创建、更新、编辑或审阅任何 .md 文件。

主要能力:检查标题、列表、空行、行长度、裸 URL、围栏代码语言等规则;支持自动修复约一半可修复问题;可通过配置文件和行内注释控制规则开关。

使用方式: 运行检查:npx markdownlint-cli2 "docs//*.md" 自动修复:npx markdownlint-cli2 --fix "docs//.md" 多路径:npx markdownlint-cli2 "docs/**/.md" "README.md" "CHANGELOG.md" 排除:npx markdownlint-cli2 "**/*.md" "#node_modules" 输出格式:filepath:line rule/alias description。退出码:0 无错误;1 有 lint 错误;2 lint 失败(如配置错误)。

配置:项目可通过 .markdownlint.json(仅规则)或 .markdownlint-cli2.jsonc / .yaml(完整 CLI 配置)设置。规则值可为 true/"error"、"warning"、false 或带参数对象。配置优先级:.markdownlint-cli2 配置 > .markdownlint 配置 > 文件内行内指令。行内指令如 markdownlint-disable、disable-line、disable-next-line、configure-file、capture/restore。

工作流:编辑后运行检查,先尝试 --fix,再手动修复不可自动修复项,重跑确认无错误;永久关闭的规则写入配置文件,一次性例外用行内指令。

规则示例:MD009 尾随空格、MD013 行长度(默认 80)、MD022 标题周围空行、MD033 禁止内联 HTML、MD034 禁止裸 URL、MD040 围栏代码需语言、MD047 文件末尾单一换行。完整 47 条规则见 references/rules.md。

限制:仅针对 Markdown 文件;部分规则不可自动修复;MD013 等规则在不同项目常被关闭,需按项目配置决定。未提供安装以外的依赖或平台要求。