Add `markdown-link-check` with `pre-commit` to check for dead links in Markdown files
未关闭
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