markdownlint-cli2-action/README.md

markdownlint-cli2-action

A GitHub Action to run the markdownlint-cli2 tool for linting Markdown/CommonMark files with markdownlint

Inputs

globs (optional)

Glob expression(s) of files to lint (newline-delimited)

The default *.{md,markdown} lints all Markdown files in the base directory of a project.

For more detail, read about glob syntax in markdownlint-cli2.

Outputs

[None]

Examples

To lint Markdown files in the base directory of a project:

- uses: DavidAnson/markdownlint-cli2-action@v1

To lint all Markdown files in a project:

- uses: DavidAnson/markdownlint-cli2-action@v1
  with:
    globs: **/*.md

To lint specific Markdown files in a project:

- uses: DavidAnson/markdownlint-cli2-action@v1
  with:
    globs: |
      README.md
      CHANGELOG.md
      docs/*.md      

See example.yml for a simple GitHub workflow that uses markdownlint-cli2-action.