From b228c2ca003a6b6abc7b53ecfc5884744bf171aa Mon Sep 17 00:00:00 2001 From: David Anson Date: Wed, 13 Jan 2021 15:30:04 -0800 Subject: [PATCH] Add examples and links to README.md. --- README.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4756df5..d360419 100644 --- a/README.md +++ b/README.md @@ -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