apache / apache/cloudstack

Add `markdown-link-check` with `pre-commit` to check for dead links in Markdown files

未關閉
#11,290 1 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視
type:enhancement
主要語言
Java
星號
3.1k
分支
1.4k
平均合併
6 天 19 小時
30 天內合併 PR
32

描述

https://github.com/tcort/markdown-link-check

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#run-as-a-pre-commit-hook

```
- repo: https://github.com/tcort/markdown-link-check
rev: ...
hooks:
- id: markdown-link-check
args: [-q]
```

We will need a config file with various rules:

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#config-file-format

貢獻指南

開啟貢獻指南

研究方向

從 issue 中連結的 markdown-link-check README 區段開始,尤其是「Run as a pre-commit hook」和「Config file format」。確認 repository 的 pre-commit 設定位置,加入 hook 及其必要規則,然後對 Markdown 檔案執行已設定的 pre-commit 檢查,以確認死鏈會如預期般被回報。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
markdown
領域
documentation, tooling
Issue 類型
功能
難度
3/5
預估耗時
1-2 天
活躍度
冷清
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。