harryvasanth/Markdown Link Checker
Checks all hyperlinks in Markdown files for broken links and reports their status
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| path | Path to check for markdown files | no | . |
| files | Specific markdown files to check (comma or space separated) | no | — |
| exclude | Files or directories to exclude (comma or space separated) | no | — |
| recursive | Check files recursively | no | true |
| timeout | Timeout for HTTP requests in seconds (both connect and max-time) | no | 10 |
| retry-count | Number of retries for failed requests | no | 3 |
| verbose | Show detailed output | no | false |
| config-file | Path to configuration file | no | — |
| ignore-urls | Comma-separated list of URLs or string patterns to ignore (e.g., 'localhost,example.com') | no | — |
| user-agent | Custom User-Agent header for HTTP requests to prevent 403 blocks | no | Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36 |
Outputs
| name | description |
|---|---|
| json | JSON output of broken links. Example: `[{"link":"https://example.com/broken","file":"README.md","line_num":5,"status":"404"}]` |