[GH-ISSUE #1855] Are all rules enabled by default? #2608

New issue

Closed

opened 2026-03-07 20:09:18 +03:00 by kerem · 2 comments

kerem commented

2026-03-07 20:09:18 +03:00

Owner

Originally created by @rgoldberg on GitHub (Nov 13, 2025).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/1855

Are all rules enabled by default?

It would be nice to document that clearly in the readme configuration section, maybe by inserting "All rules are enabled by default." or "Some rules are enabled by default." (the latter including a link to the list of default enabled rules) after the sentence starting with "Rules can be enabled, disabled, and configured".

Originally created by @rgoldberg on GitHub (Nov 13, 2025). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/1855 Are all rules enabled by default? It would be nice to document that clearly in the [readme configuration section](https://github.com/DavidAnson/markdownlint/?tab=readme-ov-file#configuration), maybe by inserting "All rules are enabled by default." or "Some rules are enabled by default." (the latter including a link to the list of default enabled rules) after the sentence starting with "Rules can be enabled, disabled, and configured".

kerem

2026-03-07 20:09:18 +03:00

closed this issue
added the
enhancement

fixed in next
labels

kerem commented

2026-03-07 20:09:20 +03:00

Author

Owner

@DavidAnson commented on GitHub (Nov 13, 2025):

When no configuration object is passed or the optional default setting is not present, all rules are enabled.

https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#optionsconfig

@DavidAnson commented on GitHub (Nov 13, 2025): > When no configuration object is passed or the optional default setting is not present, all rules are enabled. https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#optionsconfig

kerem commented

2026-03-07 20:09:20 +03:00

Author

Owner

@rgoldberg commented on GitHub (Nov 13, 2025):

Thanks for the info. I take it then, that all rules are enabled by default, unless the special default rule is set to false.

If that's correct, I think it would be simpler to state it that way.

It's also buried deep in the documentation. I think it would be useful to document it clearly near the start of the readme configuration section, maybe by rewriting the second paragraph as:

Rules can be enabled, disabled, and configured via options.config (described below) to define the expected behavior for a set of inputs. All rules are enabled by default, unless the special default rule is set to false (described below).

To enable or disable 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):

@rgoldberg commented on GitHub (Nov 13, 2025): Thanks for the info. I take it then, that all rules are enabled by default, unless the special `default` rule is set to `false`. If that's correct, I think it would be simpler to state it that way. It's also buried deep in the documentation. I think it would be useful to document it clearly near the start of the [readme configuration section](https://github.com/DavidAnson/markdownlint/?tab=readme-ov-file#configuration), maybe by rewriting the second paragraph as: Rules can be enabled, disabled, and configured via `options.config` (described below) to define the expected behavior for a set of inputs. All rules are enabled by default, unless the special `default` rule is set to `false` (described below). To enable or disable 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):