From 335b9ae31d7c8b4678db280ade748f65a6bc59e8 Mon Sep 17 00:00:00 2001 From: Laurent Guerard Date: Tue, 23 Jun 2026 14:24:08 +0200 Subject: [PATCH] =?UTF-8?q?ci:=20=F0=9F=91=B7=20enforce=20markdownlint=20o?= =?UTF-8?q?n=20all=20markdown?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a markdownlint-cli2 config + a CI gate so every .md is linted on push/PR (alongside ruff). Disable line-length/inline-HTML/code-block- style/table-style rules that fight the docs; keep the useful ones. Run `npx markdownlint-cli2 --fix` to auto-fix locally. Co-Authored-By: Claude Opus 4.8 --- .github/workflows/lint.yml | 10 ++++++++++ .markdownlint-cli2.yaml | 16 ++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 .markdownlint-cli2.yaml diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index a0b80ae..a48d538 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -23,3 +23,13 @@ jobs: with: version: "0.15.18" args: "format --check" + + markdownlint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: markdownlint + uses: DavidAnson/markdownlint-cli2-action@v20 + with: + globs: "**/*.md" diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 0000000..d2f9c8b --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,16 @@ +# markdownlint-cli2 configuration — see https://github.com/DavidAnson/markdownlint +config: + MD013: false # line length (tables, code and long prose) + MD033: false # inline HTML (badges, ) + MD041: false # first line need not be a top-level heading (badges) + MD024: + siblings_only: true # repeated headings OK across different sections + MD046: false # allow both indented and fenced code blocks + MD060: false # don't enforce table pipe spacing style +globs: + - "**/*.md" +ignores: + - "site" + - ".pixi" + - "PUBLIC" + - "**/node_modules"