test

.github/workflows/ci-docs.yml

@@ -10,6 +10,12 @@ on:
 permissions:
   contents: read
 
+env:
+  MKDOCS_STRICT: ${{ vars.MKDOCS_STRICT:-true }}
+  MKDOCS_CONFIG: mkdocs/mkdocs.yml 
+  CSPELL_CONFIG: tools/spellcheck/cspell.yml
+  CSPELL_TARGETS: "docs/**/*.md" README.md
+
 jobs:
   build-check:
     runs-on: ubuntu-latest
@@ -27,9 +33,8 @@ jobs:
         run: |
           set -euo pipefail
           npx --yes cspell \
-            --config tools/spellcheck/cspell.yml \
-            "docs/**/*.md" \
-            README.md
+            --config ${CSPELL_CONFIG \
+            ${CSPELL_TARGETS}
 
       - name: Install build dependencies
         run: |
@@ -37,8 +42,15 @@ jobs:
           pip install -r mkdocs/requirements.txt
 
       - name: MkDocs build (strict default)
+
         run: |
           set -euo pipefail
-          # Default strict on if unset
-          echo "Strict is set to {MKDOCS_STRICT:-true}"
-          tools/build.sh
+          echo "Strict is set to ${MKDOCS_STRICT}"
+          FLAGS=()
+
+          if [ "${MKDOCS_STRICT}" = "true" ]; then
+            FLAGS+=(--strict)
+          fi
+          MKDOCS_OUTPUT_DIR="${RUNNER_TEMP:-${TMPDIR:-/tmp}}/dist"
+           
+          mkdocs build "${FLAGS[@]}" -f "${MKDOCS_CONFIG}" -d "${MKDOCS_OUTPUT_DIR}"

mkdocs/mkdocs.yml

@@ -36,4 +36,8 @@ plugins:
   - enumerate-headings:
       toc_depth: 2
       exclude:
-        - index.md
+        - index.md
+
+validation:
+  links:
+    anchors: warn #this defaults to info, but it will cause broken links in anchor headers

tools/build.sh

@@ -11,5 +11,5 @@ STRICT_FLAG=""
 if [ "${MKDOCS_STRICT}" = "true" ]; then
   STRICT_FLAG="--strict"
 fi
-
+echo "MKDOCS_STRICT: $MKDOCS_STRICT, STRICT_FLAG: $STRICT_FLAG"
 mkdocs build ${STRICT_FLAG} -f $MKDOCS_CONFIG -d $OUTPUT_DIR