From edb108731067ed67a732c13ab94e73065aa9f2c9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Harper?= <hi@fred.dev>
Date: Wed, 15 Nov 2023 18:40:08 -0500
Subject: [PATCH] ci: add a workflow to validate Markdown syntax (#40)

---
 .github/workflows/check-markdown.yml | 18 ++++++++++++++++++
 .markdownlint.json                   | 12 ++++++++++++
 README.md                            |  1 +
 3 files changed, 31 insertions(+)
 create mode 100644 .github/workflows/check-markdown.yml
 create mode 100644 .markdownlint.json

diff --git a/.github/workflows/check-markdown.yml b/.github/workflows/check-markdown.yml
new file mode 100644
index 0000000..3937f5e
--- /dev/null
+++ 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/checkout@v4.1.0
+
+      - name: Validate Markdown
+        uses: DavidAnson/markdownlint-cli2-action@v13.0.0
+        with:
+          config: .markdownlint.json
+          globs: "**.md"
diff --git a/.markdownlint.json b/.markdownlint.json
new file mode 100644
index 0000000..4a29216
--- /dev/null
+++ b/.markdownlint.json
@@ -0,0 +1,12 @@
+{
+	"MD013": false,
+	"MD024": false,
+	"MD025": false,
+	"MD033": false,
+	"MD049": {
+		"style": "underscore"
+	},
+	"MD050": {
+		"style": "asterisk"
+	}
+}
\ No newline at end of file
diff --git a/README.md b/README.md
index 97acd11..46acbec 100644
--- 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">