文件撰寫通常是開發人員最後才會想到的工作——直到破損連結讓使用者感到沮喪,或是 README 將使用者導向 404 頁面。
我想要一個簡單的方式來自動驗證 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
就這樣。
每次 push 或 pull request 都能自動驗證您的文件。
我為什麼建立它
在維護文件的過程中,我注意到破損連結往往要等到有人回報才會被發現。
與其手動檢查,我想要一個輕量級工具,能直接整合到 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.