apache / apache/cloudstack

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

Open
#11,290 1 comment 1 reaction 0 assignees View on GitHub
type:enhancement
Dominant language
Java
Stars
3.1k
Forks
1.4k
Avg merge
6d 19h
Merged PRs (30d)
32

Description

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

Contributor guide

Open the contributing guide

Research direction

Start with the markdown-link-check README sections linked in the issue, especially “Run as a pre-commit hook” and “Config file format.” Determine the repository’s pre-commit configuration location, add the hook and its required rules, then run the configured pre-commit checks against Markdown files and confirm dead links are reported as intended.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.