Update markdownlint configuration to control linting errors

mendix · Feb 2, 2024 · 6ad8e33 · 6ad8e33
1 parent 5f7179c
commit 6ad8e33
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/.github/workflows/lint-action.yml b/.github/workflows/lint-action.yml
@@ -27,6 +27,7 @@ jobs:
         with:
           node-version: '20'
       # Installs linting tool via npm
+      # Look at using the related GitHub action here: https://github.com/DavidAnson/markdownlint-cli2-action
       - name: Install markdown linter
         run: npm install markdownlint-cli2 --global
       # Runs linter on content, rules specified in yaml config file

diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml
@@ -212,3 +212,18 @@ config:
 
   # MD053/link-image-reference-definitions - Link and image reference definitions should be needed
   MD053: false
+
+  # MD054 - Link and image style
+  MD054:
+    autolink: false
+    inline: true 
+    full: false
+    collapsed: false
+    shortcut: false
+
+  # MD055 - Table pipe style
+  # Turned off temporarily as too many files have issues to be recorded in PR description
+  MD055: false
+
+  # MD056 - Table column count
+  MD056: true