Configure spell check

important

Documentation repositories are in the process of being migrated to use Vale instead of CSpell.

Refer to the instructions on how to use Vale.

This template repository uses CSpell to check for misspelled words throughout the documentation. CSpell runs when you run npm run lint:spelling.

You don't often need to edit the .cspell.json file itself. However, you can add ignore paths or files if needed.

note

We don't recommend ignoring entire files by placing them into .cspell.json.

Instead, we recommend using in-line comments to disable spell check–for example, if you have a snippet of code with an example API key which CSpell picks up.

If you use a new term that causes spell check to fail, you can add the term to your project's dictionary.

If you have a large API page that causes spell check errors, it may make sense to exclude the entire file or folder.