Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-03-04 01:20:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 12

Add markdownlint-disable-file/markdownlint-enable-file inline comments (fixes #215).

Browse source
This commit is contained in:
David Anson 2019-12-04 21:31:49 -08:00
parent c0f040e5c1
commit a9251c533f
5 changed files with 85 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -141,11 +141,11 @@ Two kinds of text are ignored:
Rules can be enabled, disabled, and configured via `options.config` (described
below) to define the expected behavior for a set of inputs. To enable or disable
rules within a file, add one of these markers to the appropriate place (HTML
comments don't appear in the final markup):
rules at a particular location within a file, add one of these markers to the
appropriate place (HTML comments don't appear in the final markup):
* Disable all rules unconditionally: `<!-- markdownlint-disable -->`
* Enable all rules unconditionally: `<!-- markdownlint-enable -->`
* Disable all rules: `<!-- markdownlint-disable -->`
* Enable all rules: `<!-- markdownlint-enable -->`
* Disable one or more rules by name: `<!-- markdownlint-disable MD001 MD005 -->`
* Enable one or more rules by name: `<!-- markdownlint-enable MD001 MD005 -->`
* Capture the current rule configuration: `<!-- markdownlint-capture -->`
@ -185,6 +185,16 @@ has no effect:
space * in * emphasis <!-- markdownlint-disable --> <!-- markdownlint-enable -->
```
To apply changes to an entire file regardless of where the comment is located,
the following syntax is supported:
* Disable all rules: `<!-- markdownlint-disable-file -->`
* Enable all rules: `<!-- markdownlint-enable-file -->`
* Disable one or more rules by name: `<!-- markdownlint-disable-file MD001 -->`
* Enable one or more rules by name: `<!-- markdownlint-enable-file MD001 -->`
This can be used to "hide" `markdownlint` comments at the bottom of a file.
## API
### Linting