name: Docs Check
on:
  push:
    paths:
      - '**.md'
      - 'docs/**'
  pull_request:

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Markdown lint
        run: |
          npm install -g markdownlint-cli
          markdownlint '**/*.md' --ignore node_modules
      - name: Link check
        run: |
          npm install -g markdown-link-check
          find . -name '*.md' -not -path '*/node_modules/*' \
            -exec markdown-link-check {} \;
      - name: Spell check
        run: |
          pip install codespell
          codespell '**/*.md' --skip='*.git*'