ci: add a workflow to validate Markdown syntax

konstructio · Nov 15, 2023 · 57b97a7 · 57b97a7
1 parent 605007c
commit 57b97a7
Show file tree

Hide file tree

Showing 3 changed files with 31 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:
+  markdown-check:
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout this repository
+        uses: actions/[email protected]
+
+      - name: Validate Markdown
+        uses: DavidAnson/[email protected]
+        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"
+	}
+}
diff --git a/README.md b/README.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD041 -->
 <p align="center">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="img/kubefirst-light.svg" alt="Kubefirst Logo">