From 06a575921f7567ad1856c4953a9eebbced5b9542 Mon Sep 17 00:00:00 2001 From: David Anson Date: Sun, 12 Dec 2021 18:38:25 -0800 Subject: [PATCH] Add links to markdownlint-cli2 and markdownlint documentation for configuration (fixes #2). --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 987d60f..76511bf 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,16 @@ # markdownlint-cli2-action -A GitHub Action to run the [`markdownlint-cli2`][markdownlint-cli2] tool +> A GitHub Action to run the [`markdownlint-cli2`][markdownlint-cli2] tool for linting [Markdown][markdown]/[CommonMark][commonmark] files with [`markdownlint`][markdownlint] +`markdownlint-cli2` has extensive support for configuring options and +disabling or customizing `markdownlint` rules. See the +[`markdownlint-cli2` README][markdownlint-cli2] for more information. +`markdownlint` includes a wide variety of rules for analyzing and improving +Markdown content. See the [`markdownlint` README][markdownlint] for more +information. + ## Inputs ### globs (optional)