spellcheck

The spellcheck runs the aspell spell checker on the documentation.

Run npm run spellcheck in the root to trigger this script.

This is an interactive script, the spell checker will promptly you what to do when an issue is found. If you instruct it to, it will make changes to the documentation to fix the found issues. It will not make backup files as aspell does by default.

Under the hood, this will run:

Terminal

./scripts/spellcheck-docs.sh

Prerequisites

This relies on the aspell package being available.