chore: add workflow which checks links in markdown files

Author: SimenB

.github/workflows/markdown-link-check.yml

@@ -0,0 +1,33 @@
+name: Check Markdown links
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 12 * * *'
+  pull_request:
+    paths:
+      - '**/*.md'
+      - 'markdown_link_check_config.json'
+
+permissions:
+  contents: read
+
+jobs:
+  prepare-yarn-cache-ubuntu:
+    uses: ./.github/workflows/prepare-cache.yml
+    with:
+      os: ubuntu-latest
+
+  markdown-link-check:
+    needs: prepare-yarn-cache-ubuntu
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+          cache: yarn
+      - name: Run markdown-link-check on MD files
+        run:
+          find . -name "*.md" | grep -v node_modules | xargs -n 1 yarn
+          markdown-link-check -c markdown_link_check_config.json -q

markdown_link_check_config.json

@@ -0,0 +1,10 @@
+{
+  "httpHeaders": [
+    {
+      "urls": ["https://docs.github.com"],
+      "headers": {
+        "Accept-Encoding": "br, gzip, deflate"
+      }
+    }
+  ]
+}

package.json

@@ -131,6 +131,7 @@
     "jest": "^29.0.0",
     "jest-runner-eslint": "^1.1.0",
     "lint-staged": "^13.0.3",
+    "markdown-link-check": "^3.10.2",
     "pinst": "^3.0.0",
     "prettier": "^2.0.5",
     "rimraf": "^3.0.0",