name: Docs CI

on:
  pull_request:
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Node
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Install markdown linters
        run: |
          npm install -g markdown-link-check remark-cli remark-preset-lint-recommended

      - name: Link check
        run: |
          find docs -name '*.md' -print0 | xargs -0 -n1 markdown-link-check -q

      - name: Remark lint
        run: |
          remark docs -qf