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

Add examples and links to README.md.

Browse source
This commit is contained in:
David Anson 2021-01-13 15:30:04 -08:00
parent f86b36a138
commit b228c2ca00
1 changed files with 27 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

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