statifier/.github/workflows/lint-docs.yml at main · riddler/statifier · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
name: Lint Documentation

on:
  push:
    branches: [main]
    paths:
      - '**/*.md'
      - '.github/workflows/lint-docs.yml'
  pull_request:
    branches: [main]
    paths:
      - '**/*.md'
      - '.github/workflows/lint-docs.yml'

jobs:
  lint-docs:
    name: Lint Documentation
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v4

    - name: Lint Markdown files
      uses: DavidAnson/markdownlint-cli2-action@v13
      with:
        globs: |
          **/*.md
          !node_modules/**/*.md
          !docs/.vitepress/dist/**/*.md

    # - name: Check for broken links
    #   uses: gaurav-nelson/github-action-markdown-link-check@v1
    #   with:
    #     use-quiet-mode: 'yes'
    #     use-verbose-mode: 'yes'
    #     config-file: '.github/workflows/markdown-link-check-config.json'