mirror of
https://github.com/DavidAnson/markdownlint-cli2-action.git
synced 2024-11-21 22:01:30 +01:00
Add another example to README.md.
This commit is contained in:
parent
e783e2d336
commit
6f2edb0be1
1 changed files with 7 additions and 0 deletions
|
@ -11,6 +11,7 @@ for linting [Markdown][markdown]/[CommonMark][commonmark] files with
|
||||||
Glob expression(s) of files to lint (newline-delimited)
|
Glob expression(s) of files to lint (newline-delimited)
|
||||||
|
|
||||||
The default `*.{md,markdown}` lints all Markdown files in the base directory
|
The default `*.{md,markdown}` lints all Markdown files in the base directory
|
||||||
|
of a project
|
||||||
|
|
||||||
## Outputs
|
## Outputs
|
||||||
|
|
||||||
|
@ -18,6 +19,12 @@ The default `*.{md,markdown}` lints all Markdown files in the base directory
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
To lint Markdown files in the base directory of a project:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: DavidAnson/markdownlint-cli2-action@v1
|
||||||
|
```
|
||||||
|
|
||||||
To lint all Markdown files in a project:
|
To lint all Markdown files in a project:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|
Loading…
Reference in a new issue