Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-01-28 01:46:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add support for disabling/enabling rules within Markdown content (fixes #5).

Browse source
This commit is contained in:
David Anson 2015-09-26 16:55:33 -07:00
parent 071bba88fc
commit 31141cc3ed
10 changed files with 192 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -104,6 +104,33 @@ See [Rules.md](doc/Rules.md) for more details.
* **url** - MD034
* **whitespace** - MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039
## Configuration
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):
* Disable all rules: `<!-- markdownlint-disable -->`
* Enable all rules: `<!-- markdownlint-enable -->`
* Disable one or more rules: `<!-- markdownlint-disable MD001 MD002 -->`
* Enable one or more rules: `<!-- markdownlint-enable MD001 MD002 -->`
For example:
```md
<!-- markdownlint-disable MD037 -->
deliberate space * in * emphasis
<!-- markdownlint-enable MD037 -->
```
Changes take effect starting with the line a comment is on, so the following
has no effect:
```md
space * in * emphasis <!-- markdownlint-disable --> <!-- markdownlint-enable -->
```
## API
Standard asynchronous interface:
@ -209,7 +236,8 @@ rule to `true` or `false` includes/excludes all rules by default. Enabling or
disabling a tag name (ex: `whitespace`) affects all rules having that tag.
The `default` rule is applied first, then keys are processed in order from top
to bottom with later values overriding earlier ones.
to bottom with later values overriding earlier ones. Keys (including rule names,
tags, and `default`) are not case-sensitive.
Example: