From 1fcb4d691c5143f07511b95d228c30a4be89331a Mon Sep 17 00:00:00 2001 From: David Anson Date: Thu, 18 Jun 2020 09:55:01 -0700 Subject: [PATCH] Fix case of "Markdown"/"markdownlint", update link to rule documentation, add link to inline comment syntax. --- README.md | 2 +- docs/disabling-linters.md | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a55132e7..1c7fa454 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base | **YAML** | Yamllint | | **Python3** | Pylint | | **JSON** | JsonLint | -| **MarkDown** | Markdownlint | +| **Markdown** | markdownlint | | **Perl** | Perl | | **XML** | LibXML | | **Coffeescript** | coffeelint | diff --git a/docs/disabling-linters.md b/docs/disabling-linters.md index 525471b6..a885c9f4 100644 --- a/docs/disabling-linters.md +++ b/docs/disabling-linters.md @@ -251,15 +251,16 @@ var = "terrible code down here..." -------------------------------------------------------------------------------- ## Markdown -- [Markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli#readme) -- [Markdownlint rules](https://awesomeopensource.com/project/DavidAnson/markdownlint) +- [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli#readme) +- [markdownlint rule documentation](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md) +- [markdownlint inline comment syntax](https://github.com/DavidAnson/markdownlint#configuration) -### Markdownlint Config file +### markdownlint Config file - `.github/linters/.markdown-lint.yml` - You can pass multiple rules and overwrite default rules - File should be located at: `.github/linters/.markdownlint.yml` -### Markdownlint disable single line +### markdownlint disable single line ```markdown ## Here is some document Here is some random data @@ -268,7 +269,7 @@ any violation you want Here is more data ``` -### Markdownlint disable code block +### markdownlint disable code block ```markdown ## Here is some document Here is some random data @@ -278,7 +279,7 @@ any violations you want Here is more data ``` -### Markdownlint disable entire file +### markdownlint disable entire file - You can encapsulate the entire file with the *code block format* to disable an entire file from being parsed --------------------------------------------------------------------------------