documentation

test-doc.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+# author: deadc0de6 (https://github.com/deadc0de6)
+# Copyright (c) 2022, deadc0de6
+
+## test the doc with remark
+## https://github.com/remarkjs/remark-validate-links
+set +e
+which remark >/dev/null 2>&1
+r="$?"
+set -e
+if [ "$r" != "0" ]; then
+  echo "[WARNING] install \"remark\" to test the doc"
+else
+  remark -f -u validate-links docs/
+  remark -f -u validate-links *.md
+fi
+
+### test the doc with markdown-link-check
+### https://github.com/tcort/markdown-link-check
+#set +e
+#which markdown-link-check >/dev/null 2>&1
+#r="$?"
+#set -e
+#if [ "$r" != "0" ]; then
+#  echo "[WARNING] install \"markdown-link-check\" to test the doc"
+#else
+#  for i in `find docs -iname '*.md'`; do markdown-link-check $i; done
+#  markdown-link-check README.md
+#fi
+
+echo "documentation OK"