-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CI workflows for markdown linting and spell checking
- Loading branch information
Showing
3 changed files
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
name: Markdown Lint | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
|
||
jobs: | ||
markdown-lint: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Node.js environment | ||
uses: actions/setup-node@v2 | ||
with: | ||
node-version: '16' # Upgrade to Node.js version 16 | ||
|
||
- name: Install markdownlint-cli | ||
run: npm install -g markdownlint-cli | ||
|
||
- name: Run markdownlint on markdown files | ||
run: markdownlint '**/*.md' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
name: Spell Check | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
|
||
jobs: | ||
spell-check: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
|
||
- name: Install aspell | ||
run: sudo apt-get install -y aspell aspell-en | ||
|
||
- name: Install pyspelling | ||
run: pip install pyspelling | ||
|
||
- name: Run Spell Checker | ||
run: pyspelling -c spellcheck.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# spellcheck.yaml | ||
|
||
matrix: | ||
- name: Markdown Files | ||
sources: | ||
- '**/*.md' # Check all markdown files in the repository | ||
dictionary: | ||
# Use the default language dictionary (no need for a list of dictionaries) | ||
language: en_US # Specify the language | ||
# List of custom words to exclude (e.g., technical terms, proper names) | ||
ignore_words: | ||
- GitHub | ||
- markdownlint | ||
- pyspelling | ||
- CI | ||
- lint |