diff --git a/.github/workflows/lint-md.yml b/.github/workflows/lint-md.yml new file mode 100644 index 0000000..77f6ef8 --- /dev/null +++ b/.github/workflows/lint-md.yml @@ -0,0 +1,26 @@ +name: Lint Markdown file + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # Run on pull request + pull_request: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + # Lint Markdown file job + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: DavidAnson/markdownlint-cli2-action@v15 + with: + # Lint all markdown files in the repo + globs: '**/*.md' + # Automatically fix supported issues + fix: true