add markdownlint-cli2 and rules

EdwardAngert · EdwardAngert · commit 819074c523e5 · 2024-12-05T21:50:15.000Z
diff --git a/.github/actions/markdownlint-cli2/.markdownlint.json b/.github/actions/markdownlint-cli2/.markdownlint.json
@@ -0,0 +1,17 @@
+{
+    "outputFormatters": [
+        [ "markdownlint-cli2-formatter-pretty" ]
+    ],
+    "MD009": true,
+    "MD010": false,
+    "MD012": true, 
+    "MD013": false, 
+    "MD022": true, 
+    "MD024": false,
+    "MD029": false,
+    "MD031": true, 
+    "MD033": false,
+    "MD036": false,
+    "MD041": false,
+    "MD045": true
+}
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -221,6 +221,13 @@ jobs:
           ./scripts/check_unstaged.sh
         shell: bash
 
+      - name: markdownlint-cli2-action
+        uses: DavidAnson/markdownlint-cli2-action@v18.0.0
+        with:
+          config: '.github/actions/markdownlint-cli2-action/.markdownlint.json'
+          globs: 'docs/**/*.md'
+          fix: true
+
   gen:
     timeout-minutes: 8
     runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }}
