joshrotenberg/mdbook-lint Action
Fast markdown linting for mdBook projects with GitHub Actions integration
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| files | Files or glob patterns to lint (space-separated) | no | **/*.md |
| config-file | Path to mdbook-lint configuration file | no | .mdbook-lint.toml |
| fail-on-warnings | Fail the action on warnings (true/false) | no | true |
| rules | Comma-separated list of rules to enable/disable (e.g., "MD013,MD040") | no | — |
| format | Output format (human, json, sarif) | no | human |
| output-file | File to write output to (optional) | no | — |
| version | mdbook-lint version to use (defaults to latest) | no | latest |
Outputs
| name | description |
|---|---|
| violations | Number of violations found |
| warnings | Number of warnings found |
| errors | Number of errors found |
| sarif-file | Path to generated SARIF file (if format=sarif) |