文档往往是开发者最后考虑的事情——直到断开的链接让用户沮丧,或者 README 把人带到 404 页面。
我想要一种简单的方法在 CI 期间自动验证 Markdown 文档中的链接,于是我构建了 urldn-link-check。
这是一个开源的 GitHub Action 和 CLI,可扫描你的文档并在合并前报告问题。
特性
✅ 检测断开的链接 (404/500)
↪️ 检测重定向链
🔒 检测不安全的 HTTP 链接
📏 查找过长的 URL
📄 扫描 Markdown 和 MDX 文件
⚡ 快速并发扫描
💬 GitHub PR 摘要
📊 JSON 和 Markdown 报告
安装
npm install -D urldn-link-check
或者
npx urldn-link-check .
GitHub Action
- uses: urldn/link-check@v1
就这样。
每次推送或拉取请求都可以自动验证你的文档。
我为什么构建它
在维护文档时,我注意到断开的链接常常要等到有人报告才被发现。
我想要一个轻量级的工具,直接集成到 GitHub Actions 中并自然融入 CI 工作流,而不是手动检查。
开源
该项目采用 MIT 许可,欢迎贡献。
⭐ GitHub: https://github.com/urldn/link-check
📦 npm: https://www.npmjs.com/package/urldn-link-check
https://www.npmjs.com/package/urldn-link-check
这是 URLDN 生态系统中的首个开发者工具,未来计划推出更多开源项目。
如果你有想法或反馈,我很乐意倾听。
0 Comments
Log in to join the conversation.No comments yet. Be the first to share your thoughts.