Check and Annotate files with spelling suggestions to help you write better.
Create a .github/workflows/spell-checker.yml
file in the repository you want to install this action:
name: Spell Checker
on: push
jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: wow-actions/spell-checker@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
include: |
**/*.md
**/*.txt
A non-exhaustive list of the various checks that are run:
- Correct spelling (and provides possible corrections).
- Use of non-inclusive/profane/offensive language.
- Various prose-related checks, find the full list here.
Various inputs are defined to let you configure the action:
Note: Workflow command and parameter names are not case-sensitive.
Name | Description | Default |
---|---|---|
GITHUB_TOKEN |
The GitHub token for authentication | N/A |
include |
File patterns to match files to check. | [] |
exclude |
File patterns to ignore files. | [] |
alex |
The options of alex. Set false to disable it. |
N/A |
write-good |
The options of write-good. Set false to disable it. |
N/A |
markdown-spellcheck |
The options of alex. Set false to disable it. |
N/A |
This Action is mostly a wrapper around existing open source libraries. The majority of the work is done by those, and they deserve a ton of thanks:
The application code and associated documentation is under the MIT License