From 6ed6636c28855869e41efdb8bac3c7791d65f5d0 Mon Sep 17 00:00:00 2001
From: Jan Frenzel <jan.frenzel@tu-dresden.de>
Date: Mon, 2 Aug 2021 12:52:29 +0200
Subject: [PATCH] Added docker commands for invoking markdownlint and
 markdown-link-check.

---
 doc.zih.tu-dresden.de/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc.zih.tu-dresden.de/README.md b/doc.zih.tu-dresden.de/README.md
index bf43f66fc..772cb78fb 100644
--- a/doc.zih.tu-dresden.de/README.md
+++ b/doc.zih.tu-dresden.de/README.md
@@ -133,6 +133,16 @@ docker run -it hpc-compendium mkdocs serve -a 0.0.0.0:8000
 docker inspect `docker ps | grep hpc-compendium | cut -d' ' -f1` | sed -n '/\<IPAd/s#^.*"\([0-9.]*\)".*$#http://\1:8000#p' | head -n1
 ```
 
+If you want to check whether the markdown files are formatted properly, use the following command:
+```Bash
+docker run -it hpc-compendium markdownlint docs
+```
+
+To check whether there are links that point to a wrong target, use (this may take a while and gives a lot of output because it runs over all files):
+```Bash
+docker run -it hpc-compendium bash -c "find docs -type f -name '*.md' | xargs -L1 markdown-link-check"
+```
+
 #### Build Static Documentation
 
 To build the documentation, invoke `mkdocs build`. This will create a new directory named `public`
-- 
GitLab