actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2025-02-13 08:40:18 -05:00
Code Issues Projects Releases Packages Wiki Activity

Fix case of "Markdown"/"markdownlint", update link to rule documentation, add link to inline comment syntax.

Browse source
This commit is contained in:
David Anson 2020-06-18 09:55:01 -07:00
parent cbff376e46
commit 1fcb4d691c
2 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -24,7 +24,7 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
| **YAML** | Yamllint | | **YAML** | Yamllint |
| **Python3** | Pylint | | **Python3** | Pylint |
| **JSON** | JsonLint | | **JSON** | JsonLint |
| **MarkDown** | Markdownlint | | **Markdown** | markdownlint |
| **Perl** | Perl | | **Perl** | Perl |
| **XML** | LibXML | | **XML** | LibXML |
| **Coffeescript** | coffeelint | | **Coffeescript** | coffeelint |

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