From c6a38da28f2fccbfe32267712a4f7875e7a5c012 Mon Sep 17 00:00:00 2001 From: "gandalf-the-greybeard[bot]" Date: Wed, 11 Mar 2026 01:40:53 +0000 Subject: [PATCH 1/2] ci: add markdown linting workflow --- .github/workflows/ci.yaml | 17 +++++++++++++++++ .markdownlint-cli2.jsonc | 6 ++++++ 2 files changed, 23 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..0a7efc5 --- /dev/null +++ b/.markdownlint-cli2.jsonc @@ -0,0 +1,6 @@ +{ + "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) + } +} -- 2.52.0 From f6a2a0672905c7eb446347741d5a844314e728de Mon Sep 17 00:00:00 2001 From: "gandalf-the-greybeard[bot]" Date: Wed, 11 Mar 2026 01:55:12 +0000 Subject: [PATCH 2/2] fix: disable MD025 for frontmatter and H1 compatibility --- .markdownlint-cli2.jsonc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 0a7efc5..34bc2b4 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -1,6 +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) + "MD041": false, // Disable first-line heading rule (frontmatter often comes first) + "MD025": false // Allow frontmatter title and H1 } } -- 2.52.0