switch to rumdl for md linting

Author: rpietzsch

.gitignore

@@ -8,4 +8,4 @@ tmp
 .DS_Store
 .vscode/
 .python-version
-
+dist/

.markdownlint.jsonc

@@ -1,22 +1,15 @@
 {
-  // Example markdownlint JSON(C) configuration with all properties set to their default value
-  // Default state for all rules
   "default": true,
-  // not enforcing line break a specific lenght
   "MD013": false,
   "MD007": {
     "indent": 4
   },
-  // allow Multiple headings with the same content
   "MD024": false,
-  // allow multiple top level headings -> generated files
   "MD025": false,
-  // to be consistent with prettier
   "MD030": {
     "ul_single": 1,
     "ul_multi": 1
   },
-  // allow some html
   "MD033": {
     "allowed_elements": [
       "figure",
@@ -31,15 +24,10 @@
       "br"
     ]
   },
-  // not enfore h1 as first content of a file
+  "MD035": false,
   "MD041": false,
-  // allow missing img alt text
   "MD045": false,
-  // disabled due to admonition / tabs using indented blocks
   "MD046": false,
-  //"MD046": { "style": "fenced" },
-  // allow non-descriptive link text, like "here"
   "MD059": false,
-  // relax table formatting rules
   "MD060": false
 }

Taskfile.yml

@@ -181,7 +181,7 @@ tasks:
       - poetry run mike serve -b {{.PUBLIC_BRANCH}}
 
   format:fix:
-    desc: markdownlit md files and apply possible style fixes
+    desc: rumdl (md-lint) and apply possible style fixes
     cmds:
       - |
         {
@@ -190,18 +190,26 @@ tasks:
 
           # no recursion (top-level only)
           find . -maxdepth 1 -type f -name '*.md' -print0
-        } | xargs -0 markdownlint --config .markdownlint.jsonc --fix
+        } | xargs -0 poetry run rumdl --config .markdownlint.jsonc check --fix
 
-  check:markdownlint:
-    desc: run markdownlint on md files for style issues
+  check:rumdl:
+    desc: run rumdl (md-linter) for style issues
     cmds:
-      #- mkdir -p ./dist
+      - mkdir -p ./dist
+      - rm -f ./dist/md-lint-issues.xml
       - |
         {
           # recurse
           find ./docs -type f -name '*.md' -print0
 
           # no recursion (top-level only)
           find . -maxdepth 1 -type f -name '*.md' -print0
-        } | xargs -0 markdownlint --config .markdownlint.jsonc
-      # --json --output ./dist/markdownlint-issues.json
+        } | xargs -0 poetry run rumdl --config .markdownlint.jsonc check --output-format junit > ./dist/md-lint-issues.xml || true
+      - |
+        {
+          # recurse
+          find ./docs -type f -name '*.md' -print0
+
+          # no recursion (top-level only)
+          find . -maxdepth 1 -type f -name '*.md' -print0
+        } | xargs -0 poetry run rumdl --config .markdownlint.jsonc check