Skip to content

Commit

Permalink
Add examples and links to README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidAnson committed Jan 13, 2021
1 parent f86b36a commit b228c2c
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# markdownlint-cli2-action

A GitHub Action to run the markdownlint-cli2 tool for linting
Markdown/CommonMark files with the markdownlint library
A GitHub Action to run the [`markdownlint-cli2`][markdownlint-cli2] tool
for linting [Markdown][markdown]/[CommonMark][commonmark] files with
[`markdownlint`][markdownlint]

## Inputs

Expand All @@ -15,6 +16,28 @@ The default `*.{md,markdown}` lints all Markdown files in the base directory

[None]

## Example
## Examples

...
To lint all Markdown files in a project:

```yaml
- uses: DavidAnson/markdownlint-cli2-action@v1
with:
globs: **/*.md
```
To lint specific Markdown files in a project:
```yaml
- uses: DavidAnson/markdownlint-cli2-action@v1
with:
globs: |
README.md
CHANGELOG.md
docs/*.md
```
[commonmark]: https://commonmark.org/
[markdown]: https://wikipedia.org/wiki/Markdown
[markdownlint]: https://github.com/DavidAnson/markdownlint
[markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2

0 comments on commit b228c2c

Please sign in to comment.