I'm working on a change to some of the Kata Containers documentation, and hadn't - until today - realised that the project has a rather neat Spell Check tool that runs against documentation e.g. that written in Markdown.
To use/update this on my Ubuntu box, I needed to install those two projects: -
apt-get update && apt-get install -y hunspell
apt-get update && apt-get install -y pandoc
and then clone the Kata test project: -
git clone email@example.com:kata-containers/tests.git
I was then able to update the dictionary: -
to add in the to-be-included words, and then run the appropriate command to have kata-spell-check.sh update its own internal dictionary: -
and then run the tool itself: -
./kata-spell-check.sh check ~/foobar.md
INFO: Spell checking file '/root/foobar.md'
INFO: Spell check successful for file: '/root/foobar.md'