Skip to content

Commit 425c9d3

Browse files
committed
Explain how to check spellings locally
1 parent 8cfe213 commit 425c9d3

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,21 @@ Once setup, the site will be accessible on http://localhost:4000/docs/
3131
When you've made a change, either push it to a forked repository, or to a
3232
feature branch, and [raise a pull request][raise-a-pr].
3333
34+
### Spellings
35+
36+
Spell checking is provided via [`cspell`][cspell], a library which integrates
37+
with a number of code editors. Checking is run automatically on pull requests.
38+
39+
If you're using VSCode, be sure to [install Code Spell Checker][vscode-cspell].
40+
41+
To run the checks manually (this is optional) you'll need to:
42+
43+
0. install [NodeJS & `npm`][install-node]
44+
45+
1. run `npm test`
46+
47+
New spellings can be added to `.spelling`. Be sure to spell added words correctly!
48+
3449
### Navigation Sidebar
3550
3651
The docs navigation sidebar is generated from `_data/sidebar_tree.yaml` as part
@@ -42,3 +57,6 @@ page titles.
4257
[clone-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
4358
[install-ruby]: https://www.ruby-lang.org/en/documentation/installation/
4459
[raise-a-pr]: https://github.com/srobo/docs/pull/new/master
60+
[cspell]: https://cspell.org/
61+
[vscode-cspell]: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
62+
[install-node]: https://downloads.nodesource.com/

0 commit comments

Comments
 (0)