mirror of
https://github.com/DavidAnson/markdownlint-cli2-action.git
synced 2024-11-22 06:06:23 +01:00
Add examples and links to README.md.
This commit is contained in:
parent
f86b36a138
commit
b228c2ca00
1 changed files with 27 additions and 4 deletions
31
README.md
31
README.md
|
@ -1,7 +1,8 @@
|
||||||
# markdownlint-cli2-action
|
# markdownlint-cli2-action
|
||||||
|
|
||||||
A GitHub Action to run the markdownlint-cli2 tool for linting
|
A GitHub Action to run the [`markdownlint-cli2`][markdownlint-cli2] tool
|
||||||
Markdown/CommonMark files with the markdownlint library
|
for linting [Markdown][markdown]/[CommonMark][commonmark] files with
|
||||||
|
[`markdownlint`][markdownlint]
|
||||||
|
|
||||||
## Inputs
|
## Inputs
|
||||||
|
|
||||||
|
@ -15,6 +16,28 @@ The default `*.{md,markdown}` lints all Markdown files in the base directory
|
||||||
|
|
||||||
[None]
|
[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
|
||||||
|
|
Loading…
Reference in a new issue