ci: add a GitHub workflow to validate Markdown files (#356)

konstructio · Jul 4, 2024 · c2c0600 · c2c0600
1 parent 2ada44f
commit c2c0600
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/.github/workflows/check-markdown.yml b/.github/workflows/check-markdown.yml
@@ -0,0 +1,18 @@
+---
+name: Markdown Syntax Validation
+
+on: [push, workflow_dispatch]
+
+jobs:
+  check-markdown:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout this repository
+        uses: actions/checkout@v4.1.7
+
+      - name: Validate Markdown .md
+        uses: DavidAnson/markdownlint-cli2-action@v16.0.0
+        with:
+          config: ".markdownlint.json"
+          globs: "**.md"
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,12 @@
+{
+	"MD013": false,
+	"MD024": false,
+	"MD025": false,
+	"MD033": false,
+	"MD049": {
+		"style": "underscore"
+	},
+	"MD050": {
+		"style": "asterisk"
+	}
+}