docs: explain markdownlint yaml configuration file

This commit is contained in:
Leonard Sheng Sheng Lee 2020-10-16 19:40:54 +02:00
parent eec8ad51b5
commit f0a1605597
No known key found for this signature in database
GPG key ID: A68D759632696DBF

View file

@ -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