From f0a1605597183275f64dac563101a046fdad2ba5 Mon Sep 17 00:00:00 2001 From: Leonard Sheng Sheng Lee Date: Fri, 16 Oct 2020 19:40:54 +0200 Subject: [PATCH] docs: explain markdownlint yaml configuration file --- docs/disabling-linters.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/disabling-linters.md b/docs/disabling-linters.md index 540f4b49..1c20a525 100644 --- a/docs/disabling-linters.md +++ b/docs/disabling-linters.md @@ -718,6 +718,12 @@ foo() -- Warning is emitted. - You can pass multiple rules and overwrite default rules - File should be located at: `.github/linters/.markdown-lint.yml` +For example, disable [MD013/line-length](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013---line-length) rule using below configuration in `.github/linters/.markdown-lint.yml` file. + +```json +{ "default": true, "MD013": null } +``` + ### markdownlint disable single line ```markdown