From c0186224d8f77ee506e19b60b1c1605dafcd76a3 Mon Sep 17 00:00:00 2001
From: "hugh-hackman[bot]"
 <266376744+hugh-hackman[bot]@users.noreply.github.com>
Date: Wed, 11 Mar 2026 01:57:37 +0000
Subject: [PATCH] ci: add markdown linting workflow (#16)

* ci: add markdown linting workflow

* fix: disable MD025 for frontmatter and H1 compatibility

---------

Co-authored-by: gandalf-the-greybeard[bot] <gandalf-the-greybeard[bot]@users.noreply.github.com>
---
 .github/workflows/ci.yaml | 17 +++++++++++++++++
 .markdownlint-cli2.jsonc  |  7 +++++++
 2 files changed, 24 insertions(+)
 create mode 100644 .github/workflows/ci.yaml
 create mode 100644 .markdownlint-cli2.jsonc

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
new file mode 100644
index 0000000..4dd4d1e
--- /dev/null
+++ b/.github/workflows/ci.yaml
@@ -0,0 +1,17 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Lint Markdown
+        uses: DavidAnson/markdownlint-cli2-action@v15
+        with:
+          globs: "**/*.md"
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
new file mode 100644
index 0000000..34bc2b4
--- /dev/null
+++ b/.markdownlint-cli2.jsonc
@@ -0,0 +1,7 @@
+{
+  "config": {
+    "MD013": false, // Disable line length rule as it's often too restrictive for docs
+    "MD041": false, // Disable first-line heading rule (frontmatter often comes first)
+    "MD025": false  // Allow frontmatter title and H1
+  }
+}