mirror of https://github.com/DavidAnson/markdownlint-cli2-action.git synced 2024-11-21 13:51:28 +01:00

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

Find a file

David Anson d43ffab996 Update dependencies: @actions/core to 1.6.0, markdownlint-cli2 to 0.4.0, @vercel/ncc to 0.33.1, eslint to 8.7.0, eslint-plugin-unicorn to 40.1.0.		2022-01-22 15:33:41 -08:00
.github/workflows	Update documentation and example to reference @v4.	2021-09-14 22:17:12 -07:00
dist	Update dependencies: @actions/core to 1.6.0, markdownlint-cli2 to 0.4.0, @vercel/ncc to 0.33.1, eslint to 8.7.0, eslint-plugin-unicorn to 40.1.0.	2022-01-22 15:33:41 -08:00
test	Add passing/failing file and no/one glob to tests.	2021-01-13 14:29:36 -08:00
.eslintrc.json	Update dependencies: @actions/core to 1.6.0, markdownlint-cli2 to 0.4.0, @vercel/ncc to 0.33.1, eslint to 8.7.0, eslint-plugin-unicorn to 40.1.0.	2022-01-22 15:33:41 -08:00
.gitignore	Minor cleanup of unused/irrelevant components.	2021-01-13 14:17:17 -08:00
.npmrc	Default to package-lock=false in .npmrc.	2021-02-20 19:02:26 -08:00
action.yml	Add branding icon as suggested by GitHub Marketplace.	2021-01-13 22:22:53 -08:00
LICENSE	Initial commit	2021-01-12 21:28:47 -08:00
markdownlint-cli2-action.js	Update dependencies: eslint to 7.20.0, eslint-plugin-unicorn to 28.0.2.	2021-02-20 19:17:39 -08:00
package.json	Update dependencies: @actions/core to 1.6.0, markdownlint-cli2 to 0.4.0, @vercel/ncc to 0.33.1, eslint to 8.7.0, eslint-plugin-unicorn to 40.1.0.	2022-01-22 15:33:41 -08:00
README.md	Remove trailing space introduced by GitHub web editor.	2021-12-12 18:41:29 -08:00

README.md

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

To lint all Markdown files in a project:

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

To lint specific Markdown files in a project:

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

To prevent linting issues from failing the workflow run:

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

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