Markdown 文档链接巡检
指定代码仓库目录,批量检查 Markdown 文档的文件链接和标题锚点,列出失效链接及未被其他文档引用的页面。
功能与用途
适合在发布技术文档、合并文档改动或重整仓库目录前,检查读者能否顺着链接找到目标页面和章节。指定本地仓库目录后,它会扫描 Markdown 文档,跳过代码示例里的链接样式文本,并列出指向缺失文件或标题的链接,以及未被其他文档引用的页面。可以排除归档等不需要检查的目录,也可以在联网时额外检查外部网址。运行脚本需要 Python 3,无需安装第三方依赖。
适用场景
- 合并文档改动前检查跳转:在合并请求的分支上扫描仓库,找出文件改名或标题调整后失效的引用。
- 整理文档导航时发现遗漏页面:找出没有被其他 Markdown 文档引用的页面,判断哪些需要补进目录或索引。
- 发布新版文档前检查外部引用:开启外链检查,筛出需要人工复核的第三方参考资料链接。
适用人群
- 技术文档编辑
- 开源项目维护者
- 负责文档评审的软件开发者
使用步骤
- 确定要扫描的仓库根目录或文档目录。
- 按需指定排除路径,决定是否开启外链检查。
- 用 Python 3 运行巡检脚本。
- 查看失效链接和未被引用的页面,按需修正后重跑。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 简单
- 版本
- ac0502e
- 最近更新
- 2026-11-11
- 文件数
- 4
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过