From c2c06009e8ee090449546d1ac9e868e956853e26 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Harper?= <hi@fred.dev>
Date: Thu, 4 Jul 2024 14:15:20 -0400
Subject: [PATCH] ci: add a GitHub workflow to validate Markdown files (#356)

---
 .github/workflows/check-markdown.yml | 18 ++++++++++++++++++
 .markdownlint.json                   | 12 ++++++++++++
 2 files changed, 30 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 00000000..83fd832e
--- /dev/null
+++ 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
new file mode 100644
index 00000000..4a292165
--- /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