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

Update README.md to say explicitly that all rules are enabled by default.

Browse source
This commit is contained in:
David Anson 2024-08-24 22:20:04 -07:00
parent dfcb4529f3
commit 05a467494b
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -354,16 +354,16 @@ Type: `Object` mapping `String` to `Boolean | Object`
Configures the rules to use. Configures the rules to use.
Object keys are rule names or aliases and values are the rule's configuration. Object keys are rule names/aliases; object values are the rule's configuration.
The value `false` disables a rule, `true` enables its default configuration, The value `false` disables a rule, `true` enables its default configuration,
and passing an object customizes its settings. Setting the special `default` and passing an object value customizes that rule. Setting the special `default`
rule to `true` or `false` includes/excludes all rules by default. Enabling rule to `true` or `false` includes/excludes all rules by default. In the absence
or disabling a tag name (ex: `whitespace`) affects all rules having that of a configuration object, all rules are enabled. Enabling or disabling a tag
tag. name (ex: `whitespace`) affects all rules having that tag.
The `default` rule is applied first, then keys are processed in order The `default` rule is applied first, then keys are processed in order from top
from top to bottom with later values overriding earlier ones. Keys to bottom with later values overriding earlier ones. Keys (including rule names,
(including rule names, aliases, tags, and `default`) are not case-sensitive. aliases, tags, and `default`) are not case-sensitive.
Example: Example: