0
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint-cli2-action.git synced 2024-12-24 22:03:32 +01:00
A GitHub Action to run the markdownlint-cli2 tool for linting Markdown/CommonMark files with the markdownlint library
Find a file
2021-02-20 19:11:10 -08:00
.github/workflows Add example.yml, link, and glob syntax to README.md. 2021-01-17 20:34:17 -08:00
dist Update dependency: markdownlint-cli2 to 0.0.14. 2021-02-20 19:11:10 -08:00
test Add passing/failing file and no/one glob to tests. 2021-01-13 14:29:36 -08:00
.eslintrc.json Add ESLint to test script, address new issues. 2021-01-15 20:35:50 -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
markdownlint-cli2-action.js Add ESLint to test script, address new issues. 2021-01-15 20:35:50 -08:00
package.json Update dependency: markdownlint-cli2 to 0.0.14. 2021-02-20 19:11:10 -08:00
README.md Add example.yml, link, and glob syntax to README.md. 2021-01-17 20:34:17 -08:00

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.