mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-12-16 05:50:13 +01:00
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
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:
parent
eb378e3a66
commit
7d88637695
1 changed files with 4 additions and 5 deletions
|
|
@ -206,11 +206,10 @@ issues reported. Two kinds of text are ignored by most rules:
|
|||
- [Front matter](https://jekyllrb.com/docs/frontmatter/) (see
|
||||
`options.frontMatter` below)
|
||||
|
||||
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 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):
|
||||
All rules are enabled by default. Rules can be enabled, disabled, and configured
|
||||
for each call to the `lint` API by passing an `options.config` object (described
|
||||
below). To enable or disable rules within a file, use one of the following HTML
|
||||
comments (which are not rendered):
|
||||
|
||||
- Disable all rules: `<!-- markdownlint-disable -->`
|
||||
- Enable all rules: `<!-- markdownlint-enable -->`
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue