ci: add markdownlint check

chrisgrieser · Dec 25, 2024 · f9ddce9 · f9ddce9
1 parent 06ef972
commit f9ddce9
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml
@@ -0,0 +1,17 @@
+name: Markdownlint check
+
+on:
+  push:
+    branches: [main]
+    paths: ["**.md"]
+  pull_request:
+
+jobs:
+  markdownlint:
+    name: Markdownlint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: DavidAnson/markdownlint-cli2-action@v18
+        with:
+          globs: "**/*.md"
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -3,12 +3,17 @@
 #───────────────────────────────────────────────────────────────────────────────
 
 # MODIFIED SETTINGS
-blanks-around-headings: { lines_below: 0 } # rule of proximity
+blanks-around-headings:
+  lines_below: 0 # space waster
 ul-style: { style: sublist }
 
+# not autofixable
 ol-prefix: { style: ordered }
-line-length: { tables: false, code_blocks: false }
-no-inline-html: { allowed_elements: [img, details, summary, kbd, a, br] }
+line-length:
+  tables: false
+  code_blocks: false
+no-inline-html:
+  allowed_elements: [img, details, summary, kbd, a, br]
 
 #─────────────────────────────────────────────────────────────────────────────
 # DISABLED