john0isaac/Check Markdown
Return errors found on a pull request with problems in .md and .ipynb files.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 6, 2026
- License
- MIT
Pinned Snippet
uses: john0isaac/action-check-markdown@c255625e4ae89924a5f39a440a22e51fcc9f5893 # v1.3.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| command | The function to run and validate. | yes | check_broken_paths |
| directory | The directory that contains .md and .ipynb files. | yes | ./ |
| guide-url | The contribution guide full URL, linked in the report. When unset, uses guide-url from pyproject.toml if present, otherwise no guide link is included. | no | "" |
| github-token | GitHub token | yes | "" |
| extensions | Comma-separated file extensions to check. When unset, uses pyproject.toml if present, otherwise '.md,.ipynb'. | no | "" |
| tracking-domains | Comma-separated hostnames that must carry a wt.mc_id tracking parameter. Only affects check_urls_tracking. When unset, uses pyproject.toml if present, otherwise 'github.com,microsoft.com,visualstudio.com,aka.ms,azure.com'. | no | "" |
| skip-files | Comma-separated file names to exclude from checking. When unset, uses pyproject.toml if present, otherwise 'CODE_OF_CONDUCT.md,SECURITY.md'. | no | "" |
| skip-domains | Comma-separated domains to exclude from URL checks. Only affects check_broken_urls and check_urls_locale. | no | "" |
| skip-urls-containing | Comma-separated URL substrings to exclude from URL checks. Only affects check_broken_urls and check_urls_locale. | no | "" |
| timeout | Per-request timeout in seconds for URL checks (0-50). When unset, uses pyproject.toml if present, otherwise 20. | no | "" |
| retries | Number of attempts before a URL is reported as broken (0-10). When unset, uses pyproject.toml if present, otherwise 3. | no | "" |
| retry-on-429 | Whether a 429 response is retried honouring Retry-After instead of reported immediately as rate_limited (true/false). When unset, uses pyproject.toml if present, otherwise true. | no | "" |
| fallback-retry-delay | Seconds reported as the retry delay when a 429 carries no Retry-After header (0-300). When unset, uses pyproject.toml if present, otherwise 30. | no | "" |
| max-workers | Maximum number of concurrent URL-check worker threads. When unset, uses pyproject.toml if present, otherwise the number of available CPUs. | no | "" |
| per-host-delay | Minimum delay in seconds enforced between two requests to the same host (0.0-10.0). When unset, uses pyproject.toml if present, otherwise 0.5. | no | "" |
| report-format | Report format written when error-level issues are found. When unset, uses pyproject.toml if present, otherwise markdown. | no | "" |
| config | Path to a TOML file to read [tool.markdown-checker] configuration from, instead of discovering pyproject.toml. | no | "" |
| isolated | Ignore pyproject.toml configuration entirely for this run. | no | false |
Outputs
no outputs