dutchakdev/markdown-links-action
Markdown Link Checker, automates the process of validating links in Markdown files within a GitHub repository.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| config-file | Specify path to a markdown-link-check JSON configuration file. | yes | .markdown-links.json |
| folder-path | Specify path to a custom folder where your markdown files are located. | yes | . |
| max-depth | Specify a max-depth of directories you want to search for markdown files. | yes | -1 |
| check-modified-files-only | Use yes to only check for modified markdown files instead of checking all markdown files. | yes | no |
| base-branch | Use this to specify the base branch against which the action finds the modififed files. | yes | main |
| file-extension | Use this to specify the file extension of Markdown files. | yes | .md |
| file-path | Specify additional files you want to check | yes | "" |
| create-issue | Create issue with broken links | yes | no |
| gh-assignees | Assignees for the issue | no | "" |
| gh-labels | Labels for the issue | no | "" |
| repo-token | GitHub token | yes | "" |
| repository | GitHub repository (owner/repo) | yes | "" |
Outputs
| name | description |
|---|---|
| dead-links | List of broken links |