Add Markdown documentation linting

Signed-off-by: msteslov <msteslov@edu.hse.ru>

Author: msteslov

.github/workflows/basic.yml

@@ -34,6 +34,18 @@ jobs:
       - name: Validate CBOM
         run: scripts/validate_cbom.sh
 
+  markdownlint:
+    name: Check Markdown documentation
+    needs: [workflowcheck]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # pin@v4
+      - name: Install rumdl
+        run: python3 -m pip install --user rumdl==0.2.4
+      - name: Ensure Markdown conventions are upheld
+        run: ~/.local/bin/rumdl check --config .rumdl.toml --respect-gitignore --exclude "build,**/build" .
+
   upstreamcheck:
     name: Check upstream code is properly integrated
     needs: [workflowcheck]

.rumdl.toml

@@ -0,0 +1,25 @@
+[global]
+# Keep the initial lint configuration focused on Markdown rules that match the
+# existing documentation style and do not require unrelated documentation churn.
+enable = [
+  "MD001", # heading-increment
+  "MD004", # ul-style
+  "MD011", # no-reversed-links
+  "MD014", # commands-show-output
+  "MD018", # no-missing-space-atx
+  "MD019", # no-multiple-space-atx
+  "MD020", # no-missing-space-closed-atx
+  "MD021", # no-multiple-space-closed-atx
+  "MD023", # heading-start-left
+  "MD026", # no-trailing-punctuation
+  "MD027", # no-multiple-space-blockquote
+  "MD028", # no-blanks-blockquote
+  "MD035", # hr-style
+  "MD037", # no-space-in-emphasis
+  "MD039", # no-space-in-links
+  "MD042", # no-empty-links
+  "MD043", # required-headings
+  "MD044", # proper-names
+  "MD045", # no-alt-text
+  "MD048", # code-fence-style
+]