https://github.com/john0isaac/action-check-markdown
Validate .md and .ipynb files for writing standard.
https://github.com/john0isaac/action-check-markdown
actions continous-integration markdown testing
Last synced: 4 months ago
JSON representation
Validate .md and .ipynb files for writing standard.
- Host: GitHub
- URL: https://github.com/john0isaac/action-check-markdown
- Owner: john0isaac
- License: mit
- Created: 2023-11-21T04:14:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T19:55:22.000Z (over 1 year ago)
- Last Synced: 2025-10-25T03:35:02.666Z (7 months ago)
- Topics: actions, continous-integration, markdown, testing
- Homepage:
- Size: 38.1 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# action-check-markdown GitHub Action
An action that runs [markdown-checker](https://github.com/john0isaac/markdown-checker) on PRs and stores the found issues in the GitHub environment.
## Workflow setup
**Required input:**
- `command`: function that runs `markdown-checker` on the module you want to analyze. Available options are `check_broken_paths`, `check_paths_tracking`, `check_urls_tracking`, and `check_urls_locale`.
- `directory`: directory to run the function on. for example, `./`.
- `guide-url`: contribution guide full URL. for example, `https://github.com/john0isaac/action-check-markdown/blob/main/CONTRIBUTING.md`.
- `github-token`: for example, `${{secrets.GITHUB_TOKEN}}`.
It is necessary to include the following permissions in your job. See the example of a workflow setup below.
```(yaml)
permissions:
pull-requests: write
contents: read
```
**Example:**
```(yaml)
jobs:
check-broken-paths:
[...]
permissions:
pull-requests: write
contents: read
steps:
- uses: actions/checkout@v4
[...]
- uses: john0isaac/action-check-markdown@v1.1.0
with:
github-token: ${{secrets.GITHUB_TOKEN}}
command: check_broken_paths
directory: ./
guide-url: 'https://github.com/john0isaac/action-check-markdown/blob/main/CONTRIBUTING.md'
```