Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-22 05:40:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Resolve README.md-specific MD013/line-length violations.

Browse source
This commit is contained in:
David Anson 2021-11-10 22:11:43 -08:00
parent 80863476b9
commit 090bbaa30f
1 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -33,8 +33,10 @@ and test cases came directly from that project.
### Related ### Related
* CLI * CLI
* [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) command-line interface for Node.js ([works with pre-commit](https://github.com/igorshubovych/markdownlint-cli#use-with-pre-commit)) * [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli)
* [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) command-line interface for Node.js ([works with pre-commit](https://github.com/DavidAnson/markdownlint-cli2#pre-commit)) command-line interface for Node.js ([works with pre-commit](https://github.com/igorshubovych/markdownlint-cli#use-with-pre-commit))
* [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2)
command-line interface for Node.js ([works with pre-commit](https://github.com/DavidAnson/markdownlint-cli2#pre-commit))
* GitHub * GitHub
* [GitHub Super-Linter Action](https://github.com/github/super-linter) * [GitHub Super-Linter Action](https://github.com/github/super-linter)
* [GitHub Actions problem matcher for markdownlint-cli](https://github.com/xt0rted/markdownlint-problem-matcher) * [GitHub Actions problem matcher for markdownlint-cli](https://github.com/xt0rted/markdownlint-problem-matcher)
@ -165,10 +167,12 @@ appear in the final markup):
* Disable all rules: `<!-- markdownlint-disable -->` * Disable all rules: `<!-- markdownlint-disable -->`
* Enable all rules: `<!-- markdownlint-enable -->` * Enable all rules: `<!-- markdownlint-enable -->`
* Disable all rules for the next line only: `<!-- markdownlint-disable-next-line -->` * Disable all rules for the next line only:
`<!-- markdownlint-disable-next-line -->`
* Disable one or more rules by name: `<!-- markdownlint-disable MD001 MD005 -->` * Disable one or more rules by name: `<!-- markdownlint-disable MD001 MD005 -->`
* Enable one or more rules by name: `<!-- markdownlint-enable MD001 MD005 -->` * Enable one or more rules by name: `<!-- markdownlint-enable MD001 MD005 -->`
* Disable one or more rules by name for the next line only: `<!-- markdownlint-disable-next-line MD001 MD005 -->` * Disable one or more rules by name for the next line only:
`<!-- markdownlint-disable-next-line MD001 MD005 -->`
* Capture the current rule configuration: `<!-- markdownlint-capture -->` * Capture the current rule configuration: `<!-- markdownlint-capture -->`
* Restore the captured rule configuration: `<!-- markdownlint-restore -->` * Restore the captured rule configuration: `<!-- markdownlint-restore -->`
@ -231,7 +235,7 @@ more rules for a file, the following more advanced syntax is supported:
For example: For example:
```markdown ```markdown
<!-- markdownlint-configure-file { "MD013": { "line_length": 70 } } --> <!-- markdownlint-configure-file { "MD013": { "code_blocks": false } } -->
``` ```
or or