核心用法
markdown-validator 是一个命令行工具技能,用于检测 Markdown 文档中的失效本地链接。通过递归扫描指定目录或单个文件,识别相对路径引用(如 ./file.md)是否指向真实存在的文件,同时智能忽略外部 URL(http/https)和文件内锚点(#anchor)。
显著优点
1. 精准定位问题:输出包含断链所在文件、行号、链接文本和失效 URL 的结构化 JSON 报告,便于开发者快速修复
2. 智能过滤机制:自动排除外部链接和内部锚点,避免误报,专注于本地文档一致性
3. 灵活的使用方式:支持目录递归扫描或单文件验证,适应 CI/CD 集成和本地开发两种场景
4. 轻量无依赖:基于 Node.js 实现,无需复杂配置即可运行
潜在缺点与局限性
- 范围受限:仅检测文件存在性,不验证外部 URL 可达性,也不检查锚点有效性
- 无自动修复:仅提供检测报告,需人工介入修改断链
- Node.js 依赖:需要预装 Node.js 运行时环境
- 无配置选项:缺少忽略规则、输出格式自定义等高级功能
适合人群
- 技术文档维护者、开源项目贡献者
- 需要保障文档一致性的 DevOps 工程师
- 大型知识库或 Wiki 的管理员
常规风险
- 误将故意指向未生成文件的链接(如构建产物)标记为断链
- 符号链接或特殊文件系统可能导致路径解析异常
- JSON 输出在超大项目中可能内存占用较高