mirror of
https://github.com/DavidAnson/markdownlint-cli2-action.git
synced 2024-11-24 07:06:23 +01:00
Add example.yml, link, and glob syntax to README.md.
This commit is contained in:
parent
ea5cc041bf
commit
38b6b60393
2 changed files with 20 additions and 1 deletions
12
.github/workflows/example.yml
vendored
Normal file
12
.github/workflows/example.yml
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: DavidAnson/markdownlint-cli2-action@v1
|
||||
with:
|
||||
globs: |
|
||||
*.md
|
||||
!test/*.md
|
|
@ -11,7 +11,9 @@ for linting [Markdown][markdown]/[CommonMark][commonmark] files with
|
|||
Glob expression(s) of files to lint (newline-delimited)
|
||||
|
||||
The default `*.{md,markdown}` lints all Markdown files in the base directory
|
||||
of a project
|
||||
of a project.
|
||||
|
||||
For more detail, read about [glob syntax in `markdownlint-cli2`][glob-syntax].
|
||||
|
||||
## Outputs
|
||||
|
||||
|
@ -44,7 +46,12 @@ To lint specific Markdown files in a project:
|
|||
docs/*.md
|
||||
```
|
||||
|
||||
See [`example.yml`][example-yml] for a simple GitHub workflow that uses
|
||||
`markdownlint-cli2-action`.
|
||||
|
||||
[commonmark]: https://commonmark.org/
|
||||
[example-yml]: .github/workflows/example.yml
|
||||
[glob-syntax]: https://github.com/DavidAnson/markdownlint-cli2#use
|
||||
[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