jekyll/.github/actions/spelling
Olly Headey 7558ecb1f7
Allow marking specific highlighted lines via Liquid (#9138)
Merge pull request 9138
2022-11-03 07:40:54 -07:00
..
README.md Update spell-check workflow configuration 2021-10-10 12:55:55 +05:30
advice.md Update spell-check workflow configuration 2021-10-10 12:55:55 +05:30
allow.txt Fix spelling errors in History document 2022-10-20 21:57:37 +05:30
excludes.txt Update spell-check workflow configuration 2021-10-10 12:55:55 +05:30
expect.txt Fix spelling errors in History document 2022-10-20 21:57:37 +05:30
only.txt Spell check action for markdown documentation (#8675) 2021-05-16 08:14:47 -04:00
patterns.txt Allow marking specific highlighted lines via Liquid (#9138) 2022-11-03 07:40:54 -07:00
reject.txt Spell check action for markdown documentation (#8675) 2021-05-16 08:14:47 -04:00

README.md

check-spelling/check-spelling configuration

File Purpose Format Info
dictionary.txt Replacement dictionary (creating this file will override the default dictionary) one word per line dictionary
allow.txt Add words to the dictionary one word per line (only letters and 's allowed) allow
reject.txt Remove words from the dictionary (after allow) grep pattern matching whole dictionary words reject
excludes.txt Files to ignore entirely perl regular expression excludes
only.txt Only check matching files (applied after excludes) perl regular expression only
patterns.txt Patterns to ignore from checked lines perl regular expression (order matters, first match wins) patterns
expect.txt Expected words that aren't in the dictionary one word per line (sorted, alphabetically) expect
advice.txt Supplement for GitHub comment when unrecognized words are found GitHub Markdown advice

Note: you can replace any of these files with a directory by the same name (minus the .txt extension) and then include multiple files (with a .txt extension) inside that directory to merge multiple files together.