markdownlint-cli2-action

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

markdownlint-cli2 has extensive support for configuring options and disabling or customizing markdownlint rules. See the markdownlint-cli2 README for more information. markdownlint includes a wide variety of rules for analyzing and improving Markdown content. See the markdownlint README for more information.

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@v5

To lint all Markdown files in a project:

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

To lint specific Markdown files in a project:

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

To prevent linting issues from failing the workflow run:

- uses: DavidAnson/markdownlint-cli2-action@v5
  continue-on-error: true

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