diff --git a/Dockerfile b/Dockerfile index d8d77ca7c6dd279a5194a27fa854be94a9e5ff70..67ffffaa2e29c4effe35714e3dca8128872252f6 100644 --- a/Dockerfile +++ b/Dockerfile @@ -12,7 +12,7 @@ RUN pip install -r /src/doc.zih.tu-dresden.de/requirements.txt # Linter # ########## -RUN apt update && apt install -y nodejs npm +RUN apt update && apt install -y nodejs npm aspell RUN npm install -g markdownlint-cli markdown-link-check diff --git a/doc.zih.tu-dresden.de/README.md b/doc.zih.tu-dresden.de/README.md index f18af80c492095f6d06f7886ba115c3aba488a75..b538ce9407246d5bf4d44177e77ae2ff64adb1a4 100644 --- a/doc.zih.tu-dresden.de/README.md +++ b/doc.zih.tu-dresden.de/README.md @@ -157,6 +157,14 @@ To check a single file, e. g. `doc.zih.tu-dresden.de/docs/software/big_data_fram docker run --name=hpc-compendium --rm -it -w /docs --mount src="$(pwd)"/doc.zih.tu-dresden.de,target=/docs,type=bind hpc-compendium markdown-link-check docs/software/big_data_frameworks.md ``` +For spell-checking all files, use: + +```Bash +docker run --name=hpc-compendium --rm -it -w /docs --mount src="$(pwd)"/doc.zih.tu-dresden.de,target=/docs,type=bind hpc-compendium ./spellcheck.sh +``` + +This outputs all words of all files that are unknown to the spell checker. To let the spell checker "know" a word, append it to `doc.zih.tu-dresden.de/wordlist.aspell`. + #### Build Static Documentation To build the documentation, invoke `mkdocs build`. This will create a new directory named `public` diff --git a/doc.zih.tu-dresden.de/spellcheck.sh b/doc.zih.tu-dresden.de/spellcheck.sh new file mode 100755 index 0000000000000000000000000000000000000000..78847b5bc49230738c75d95770f19fca128d96a6 --- /dev/null +++ b/doc.zih.tu-dresden.de/spellcheck.sh @@ -0,0 +1,5 @@ +#!/bin/bash +for i in `find -name \*.md` +do +cat $i | aspell -p ./wordlist.aspell list +done | sort -u diff --git a/doc.zih.tu-dresden.de/wordlist.aspell b/doc.zih.tu-dresden.de/wordlist.aspell new file mode 100644 index 0000000000000000000000000000000000000000..56016a3f1279dda1bfa2acdd4de75c86e57147b1 --- /dev/null +++ b/doc.zih.tu-dresden.de/wordlist.aspell @@ -0,0 +1 @@ +personal_ws-1.1 en 1805