关键信息
- 分类
- 开发与 Web
- 输入类型
- textarea, select
- 输出类型
- text
- 样本覆盖
- 4
- 支持 API
- Yes
概览
Markdown 链接检查器是一款高效的静态分析工具,专门用于检测 Markdown 文档中的链接格式错误、悬空锚点以及未定义的引用链接。该工具完全在本地进行静态解析,不发起任何网络请求,在保障文档隐私安全的前提下,帮助您在发布或渲染文档前快速排查排版与链接引用问题。
适用场景
- •在发布技术文档、博客文章或开源项目 README 之前,需要确保所有内部跳转锚点和引用链接正确无误时。
- •在离线或无网环境下,需要快速校验 Markdown 语法中的链接格式,避免因拼写错误导致页面跳转失败时。
- •整理大型 Markdown 知识库或多文档项目时,需要批量排查未使用的引用定义或重复的锚点标识时。
工作原理
- •将需要检查的 Markdown 文本粘贴到输入框中。
- •选择检查级别(基础级别检查格式与悬空锚点,严格级别增加检查未用引用与重复锚点)并选择报告格式(文本或 JSON)。
- •工具在本地静态解析 Markdown 语法树,提取所有链接、锚点和引用定义进行交叉比对。
- •实时输出详细的检查报告,指出具体存在问题的链接类型及所在位置。
使用场景
用户案例
1. 排查技术文档中的失效内部锚点
技术文档工程师- 背景原因
- 编写了一篇长达数万字的 API 使用指南,期间多次修改了章节标题,担心文档内部的快速跳转链接(锚点)失效。
- 解决问题
- 手动逐个点击测试内部跳转链接效率极低,且容易遗漏。
- 如何使用
- 将 Markdown 文档内容粘贴至输入框,选择“基础(格式 + 悬空锚点)”检查级别,报告格式选择“文本报告”,点击运行。
- 示例配置
-
checkLevel: "basic", reportFormat: "text" - 效果
- 报告清晰指出 `#api-setup` 锚点未找到对应的标题,发现是因为标题被修改为了 `## API Setup Guide`,修改后链接恢复正常。
2. 清理学术论文草稿中的冗余引用
科研人员- 背景原因
- 使用 Markdown 撰写论文,并使用引用式链接管理参考文献,在反复删改段落后,可能遗留了未使用的文献引用定义。
- 解决问题
- 需要找出哪些引用定义已经不再被正文提及,以及是否有未定义直接使用的引用标识。
- 如何使用
- 粘贴论文草稿,将检查级别设置为“严格(增加未用引用、重复锚点)”,报告格式选择“JSON”。
- 示例配置
-
checkLevel: "strict", reportFormat: "json" - 效果
- 工具输出 JSON 格式的报告,列出了 3 处定义了但未在正文中使用的引用标识,以及 1 处未定义直接使用的引用,方便快速清理和修正。
用 Samples 测试
markdown相关专题
常见问题
这个工具会向外网发送请求来测试链接的可访问性吗?
不会。这是一个静态检查器,仅通过解析 Markdown 语法来验证本地锚点、引用定义和链接格式,不会发起任何网络请求。
什么是“悬空锚点”?
悬空锚点是指链接指向了当前文档中不存在的标题锚点,例如链接为 `[跳转](#不存在的标题)`,但文档中并没有对应的标题。
基础检查和严格检查有什么区别?
基础检查只验证链接格式和悬空锚点;严格检查在此基础上,还会检测是否存在定义了但未使用的引用链接,以及是否存在重复的标题锚点。
为什么我的外部链接(如 https://example.com)没有被标记为失效?
因为该工具是静态检查器,不进行联网探测。它只会检查外部链接的语法格式是否正确,而不会验证该网页在互联网上是否真实存在。
报告格式中的 JSON 有什么用?
JSON 格式的报告结构清晰,便于您将检查结果复制并集成到其他自动化脚本或 CI/CD 工作流中进行二次处理。