aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile2
-rw-r--r--SETUP.md12
2 files changed, 14 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 0137e88..9ef3a86 100644
--- a/Makefile
+++ b/Makefile
@@ -20,6 +20,8 @@ all: doc
doc: docs $(patsubst %,docs/%,$(subst -,/,$(notdir $(wildcard source/*))))
mkdocs build
+
+check:
checklink site/index.html
docs:
diff --git a/SETUP.md b/SETUP.md
index 14e6c60..cd1492e 100644
--- a/SETUP.md
+++ b/SETUP.md
@@ -22,6 +22,11 @@ you additionally need `MKDocs` and some helper tools:
sudo apt install make w3c-linkchecker libtext-hogan-perl mkdocs
+For checking quality of generated website,
+you need an extra helper tool:
+
+ sudo apt install w3c-linkchecker
+
## Fetch features
@@ -49,6 +54,13 @@ This command generates a website from the feature texts:
make
+## Check website
+
+This command checks generated website for flaws in links:
+
+ make check
+
+
## Cleanup
All fetched and generated files can be removed