diff --git a/.gitea/workflows/markdown-lint.yml b/.gitea/workflows/markdown-lint.yml new file mode 100644 index 0000000..f1a9739 --- /dev/null +++ b/.gitea/workflows/markdown-lint.yml @@ -0,0 +1,37 @@ +name: Markdown Validation + +on: + push: + branches: [main] + pull_request: + types: [opened, reopened, synchronize] + +jobs: + amd64: + runs-on: [ ubuntu-24.04, amd64-builder ] + steps: + - name: System Info + run: uname -m + + - name: Setup + run: | + apt update -y + apt install -y curl gnupg + curl -fsSL https://deb.nodesource.com/setup_20.x | bash - + apt install -y nodejs + + - name: Checkout + uses: actions/checkout@v4 + + - name: Install markdownlint-cli + run: | + npm ci || npm install + npm i -D markdownlint-cli + + - name: Run markdownlint + # The glob pattern finds all markdown files recursively. + # Adjust if you store docs elsewhere (e.g., docs/**/*.md). + run: | + npx markdownlint "**/*.md" \ + --ignore node_modules \ + --config .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..82fb955 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,8 @@ +{ + "default": true, + + // Example customisations – adjust or delete as needed + "MD013": { "line_length": 120 }, // max line length (set higher if you prefer) + "MD041": false, // allow first line not to be a top‑level heading + "MD033": false // allow inline HTML (useful for Gollum embeds) +}