From fa80dbfb52922b74a54e55331b2f3ec86da683ff Mon Sep 17 00:00:00 2001 From: David Anson Date: Sun, 12 Dec 2021 18:24:10 -0800 Subject: [PATCH] Add example of continue-on-error to the README (fixes #3). --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 6c25e2a..987d60f 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,13 @@ To lint specific Markdown files in a project: docs/*.md ``` +To prevent linting issues from failing the workflow run: + +```yaml +- uses: DavidAnson/markdownlint-cli2-action@v4 + continue-on-error: true +``` + See [`example.yml`][example-yml] for a simple GitHub workflow that uses `markdownlint-cli2-action`.