Make default rule enablement more explicit in README (closes #1855).
Some checks failed
Checkers / linkcheck (push) Has been cancelled
Checkers / spellcheck (push) Has been cancelled
CI / build (20, macos-latest) (push) Has been cancelled
CI / build (20, ubuntu-latest) (push) Has been cancelled
CI / build (20, windows-latest) (push) Has been cancelled
CI / build (22, macos-latest) (push) Has been cancelled
CI / build (22, ubuntu-latest) (push) Has been cancelled
CI / build (22, windows-latest) (push) Has been cancelled
CI / build (24, macos-latest) (push) Has been cancelled
CI / build (24, ubuntu-latest) (push) Has been cancelled
CI / build (24, windows-latest) (push) Has been cancelled
CI / pnpm (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
TestRepos / build (latest, ubuntu-latest) (push) Has been cancelled
UpdateTestRepos / update (push) Has been cancelled

This commit is contained in:
David Anson 2025-11-13 19:32:24 -08:00
parent eb378e3a66
commit 7d88637695

View file

@ -206,11 +206,10 @@ issues reported. Two kinds of text are ignored by most rules:
- [Front matter](https://jekyllrb.com/docs/frontmatter/) (see - [Front matter](https://jekyllrb.com/docs/frontmatter/) (see
`options.frontMatter` below) `options.frontMatter` below)
Rules can be enabled, disabled, and configured via `options.config` All rules are enabled by default. Rules can be enabled, disabled, and configured
(described below) to define the expected behavior for a set of inputs. for each call to the `lint` API by passing an `options.config` object (described
To enable or disable rules at a particular location within a file, add below). To enable or disable rules within a file, use one of the following HTML
one of these markers to the appropriate place (HTML comments don't comments (which are not rendered):
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 -->`