Add Markdownlint to CI (and ignore all rules for now) (#6842)

Author: SeanKilleen

.github/linters/.markdownlint.yml

@@ -0,0 +1,41 @@
+---
+###########################
+###########################
+## Markdown Linter rules ##
+###########################
+###########################
+
+# Linter rules doc:
+# - https://github.com/DavidAnson/markdownlint
+#
+# Note:
+# To comment out a single error:
+#   <!-- markdownlint-disable -->
+#   any violations you want
+#   <!-- markdownlint-restore -->
+#
+
+###############
+# Rules by id #
+###############
+MD001: false
+MD009: false
+MD012: false
+MD013: false
+MD018: false
+MD022: false
+MD024: false
+MD025: false
+MD026: false
+MD028: false
+MD029: false
+MD031: false
+MD032: false
+MD033: false
+MD034: false
+MD036: false
+MD037: false
+MD040: false
+MD041: false
+MD045: false
+MD053: false

.github/workflows/ci.yml

@@ -86,7 +86,20 @@ jobs:
 
     - name: run cspell
       run: cspell --config ./cSpell.json "website/src/**/*.md" --no-progress --no-cache
-
+  linting:
+    name: "Markdown linting"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        name: Check out the code
+      - uses: actions/setup-node@v4
+        name: Setup node
+        with:
+          node-version: '20'
+      - run: npm install -g markdownlint-cli2
+        name: Install markdownlint-cli2
+      - run: markdownlint-cli2 --config ".github/linters/.markdownlint.yml" "website/src/**/*.md"
+        name: run Markdownlint
   website-tests:
     name: "Website Tests"
     needs: check-changes

.markdownlintrc

@@ -0,0 +1,23 @@
+{
+  "MD001": false,
+  "MD009": false,
+  "MD012": false,
+  "MD013": false,
+  "MD018": false,
+  "MD022": false,
+  "MD024": false,
+  "MD025": false,
+  "MD026": false,
+  "MD028": false,
+  "MD029": false,
+  "MD031": false,
+  "MD032": false,
+  "MD033": false,
+  "MD034": false,
+  "MD036": false,
+  "MD037": false,
+  "MD040": false,
+  "MD041": false,
+  "MD045": false,
+  "MD053": false
+}