actions/markdownlint-cli2-action
0
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint-cli2-action.git synced 2024-11-24 15:16:26 +01:00
Code Activity

Add example.yml, link, and glob syntax to README.md.

Browse source
This commit is contained in:
David Anson 2021-01-17 20:34:17 -08:00
parent ea5cc041bf
commit 38b6b60393
2 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
.github/workflows/example.yml vendored Normal file
View 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

9
README.md
View file

@ -11,7 +11,9 @@ 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 of a project.
For more detail, read about [glob syntax in `markdownlint-cli2`][glob-syntax].
## Outputs ## Outputs
@ -44,7 +46,12 @@ To lint specific Markdown files in a project:
docs/*.md docs/*.md
``` ```
See [`example.yml`][example-yml] for a simple GitHub workflow that uses
`markdownlint-cli2-action`.
[commonmark]: https://commonmark.org/ [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 [markdown]: https://wikipedia.org/wiki/Markdown
[markdownlint]: https://github.com/DavidAnson/markdownlint [markdownlint]: https://github.com/DavidAnson/markdownlint
[markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2 [markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2