SuperAPI AI 工具集

markdown-lint

编程与开发

查看项目

更新于 10-15 16:43

技能介绍

用途:为 Git 仓库初始化或迁移 Markdown 格式标准,使用 markdownlint-cli2 加自定义脚本禁止水平线,并通过 pre-commit hook 在提交时拦截违规。适用于新仓库初始化、已有仓库检查/批量修复、把标准复制到另一仓库。单文件检查可直接运行 npx markdownlint-cli2 file.md,不需走 setup;文章内容审校不在本技能范围。

依赖:Node.js 必需,markdownlint-cli2 用 npx 无需安装,pre-commit 可选:uv tool install pre-commit --with pre-commit-uv 或 pipx install pre-commit 或 brew install pre-commit。技能加载时不会主动验证工具,命令失败再逐步引导安装。

主要能力与用法:创建 .markdownlint.json 并关闭 MD013、MD033、MD035、MD036、MD041、MD060 等规则,按仓库内容可追加禁用 MD025、MD045、MD051、MD056;创建 .pre-commit-config.yaml,引用 DavidAnson/markdownlint-cli2 并配置本地 no-horizontal-rules hook,创建后运行 pre-commit autoupdate 更新 rev;从 scripts/check-horizontal-rules.sh 复制并 chmod +x;用 awk 脚本批量删除 frontmatter 之外的 ---,注意 grep 需用 .md:[0-9]+: 过滤错误消息;运行 npx markdownlint-cli2 --fix "**/*.md" 自动修复并复查,monorepo 加 "#repos" "#node_modules" 排除;分析错误分布后处理 --fix 无法自动修复的 MD040 等;执行 pre-commit install 并验证 hook 能被拦截。

限制:--fix 无法修复所有规则;Windows 下 .sh 脚本需 Git Bash 或 WSL;frontmatter 的 --- 需保留,误删需确认第 1 行;批量删除可能残留 .tmp 文件;文件中的 rev 版本可能过时。文中提及的个人知识插件等外部依赖属资料陈述,是否可用暂未提供。