Merge pull request #4025 from ralfhandl/3.2.0-markdown-updates

Markdown updates for 3.2.0

.github/workflows/validate-markdown.yaml

@@ -23,10 +23,12 @@ jobs:
         fetch-depth: 0
     - name: use the javascript environment from main
       run: |
-        git checkout remotes/origin/main -- package.json package-lock.json
+        git checkout remotes/origin/main -- package.json package-lock.json .markdownlint.yaml
     - uses: actions/setup-node@v4 # setup Node.js
       with:
         node-version: '20.x'
     - name: Validate markdown
       run: npx --yes mdv versions/3.*.md
+    - name: Lint markdown v3.2.*
+      run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/3.2.*.md
 

.markdownlint.yaml

@@ -0,0 +1,16 @@
+# Unordered list symbol
+MD004:
+    style: asterisk
+
+# Unordered list indentation
+MD007:
+    indent: 2
+
+MD012: false # allow blank lines
+
+MD013:
+    line_length: 800
+    tables: false
+
+MD024: false # duplicate headings
+MD033: false # inline HTML

package.json

@@ -26,6 +26,7 @@
   "devDependencies": {
     "@hyperjump/json-schema": "^0.17.0",
     "chai": "^4.3.1",
+    "markdownlint-cli": "^0.41.0",
     "mdv": "^1.0.7",
     "mocha": "^8.3.0",
     "yaml": "^1.8.3"
@@ -36,5 +37,8 @@
     "Swagger",
     "schema",
     "API"
-  ]
+  ],
+  "scripts": {
+    "format-markdown": "bash ./scripts/format-markdown.sh ./versions/3.2.0.md"
+  }
 }

scripts/format-markdown.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+SRCDIR="$(dirname "${BASH_SOURCE[0]}")" # check on Windows
+
+for filename in $*; do
+  # mostly to format code blocks with examples, unfortunately messes up bullet lists and tables
+  npx prettier --write --single-quote $filename
+
+  # repair the tables: remove superfluos spaces and dashes that make diffing revisions harder
+  # and sed -i is not portable, so we need to use a temporary file
+  sed -E -e "s/  +\|/ |/g" -e "s/\|  +/| /g" -e "s/-----+/----/g" $filename > $filename.tmp && mv $filename.tmp $filename
+
+  # repair the bullet lists and various other markdown formatting issues
+  npx --yes markdownlint-cli --fix --config $SRCDIR/../.markdownlint.yaml $filename
+done