actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-22 16:51:05 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #118 from DavidAnson/master

Browse source 
Fix case of "Markdown"/"markdownlint", update link to rule documentation, add link to inline comment syntax.
This commit is contained in:
Lukas Gravley 2020-06-18 12:09:02 -05:00 committed by GitHub
commit 9b301300ec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/disabling-linters.md
View file

@ -251,15 +251,16 @@ var = "terrible code down here..."
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
## Markdown ## Markdown
- [Markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli#readme) - [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli#readme)
- [Markdownlint rules](https://awesomeopensource.com/project/DavidAnson/markdownlint) - [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` - `.github/linters/.markdown-lint.yml`
- You can pass multiple rules and overwrite default rules - You can pass multiple rules and overwrite default rules
- File should be located at: `.github/linters/.markdownlint.yml` - File should be located at: `.github/linters/.markdownlint.yml`
### Markdownlint disable single line ### markdownlint disable single line
```markdown ```markdown
## Here is some document ## Here is some document
Here is some random data Here is some random data
@ -268,7 +269,7 @@ any violation you want
<!-- markdownlint-restore --> <!-- markdownlint-restore -->
Here is more data Here is more data
``` ```
### Markdownlint disable code block ### markdownlint disable code block
```markdown ```markdown
## Here is some document ## Here is some document
Here is some random data Here is some random data
@ -278,7 +279,7 @@ any violations you want
Here is more data 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 - You can encapsulate the entire file with the *code block format* to disable an entire file from being parsed
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------