Skip to content
Snippets Groups Projects
Commit feb506f5 authored by Jan Frenzel's avatar Jan Frenzel
Browse files

Added a way to spell-check files.

parent 69a59dc7
No related branches found
No related tags found
3 merge requests!322Merge preview into main,!319Merge preview into main,!227Added a way to spell-check files.
......@@ -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
......
......@@ -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`
......
#!/bin/bash
for i in `find -name \*.md`
do
cat $i | aspell -p ./wordlist.aspell list
done | sort -u
personal_ws-1.1 en 1805
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment