Add linter for markdown in CI and custom rules

gevhaz · Nov 18, 2024 · 174caa8 · 174caa8
1 parent 95a6f27
commit 174caa8
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml
@@ -26,6 +26,14 @@ jobs:
           filter_mode: nofilter
           fail_on_error: false
 
+  markdownlint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Run mdl
+        uses: actionshub/markdownlint@main
+
   build:
     runs-on: ubuntu-latest
     env:

diff --git a/.mdl.rb b/.mdl.rb
@@ -0,0 +1,9 @@
+all
+
+exclude_rule "MD014"
+
+exclude_rule "MD026"
+
+exclude_rule "MD033"
+
+rule "MD013", :tables => false
diff --git a/.mdlrc b/.mdlrc
@@ -0,0 +1 @@
+style ".mdl.rb"