Mention 'markdownlint-rule-search-replace' rule in documentation

This commit is contained in:
OnkarRuikar 2022-12-10 08:04:45 +05:30 committed by David Anson
parent bdac708a41
commit 068b090293
4 changed files with 27 additions and 8 deletions

View file

@ -20,8 +20,8 @@ CodeQL
CodiMD CodiMD
CommonMark CommonMark
config config
Config
config. config.
Config
CVE-2022-21670 CVE-2022-21670
docs-util docs-util
ES2015 ES2015
@ -48,6 +48,7 @@ markdownlint
markdownlint-cli markdownlint-cli
markdownlint-cli2 markdownlint-cli2
markdownlint-rule-helpers markdownlint-rule-helpers
markdownlint-rule-search-replace
matcher matcher
MD\d\d\d MD\d\d\d
MD\d\d\d-MD\d\d\d MD\d\d\d-MD\d\d\d
@ -79,9 +80,9 @@ Reactable
README README
reimplement reimplement
setext setext
setext-style
setext_with_atx setext_with_atx
setext_with_atx_closed setext_with_atx_closed
setext-style
single-h1 single-h1
sublist sublist
Super-Linter Super-Linter
@ -90,8 +91,8 @@ TOML
trimLeft trimLeft
trimRight trimRight
ul ul
ul_single
ul-indent ul-indent
ul_single
ul-start-left ul-start-left
ul-style ul-style
unhandled unhandled

View file

@ -137,6 +137,15 @@ See [Rules.md](doc/Rules.md) for more details.
> aliases (e.g. `heading-increment` is also available as `header-increment`). > aliases (e.g. `heading-increment` is also available as `header-increment`).
> The use of `header` is deprecated and provided for backward-compatibility. > The use of `header` is deprecated and provided for backward-compatibility.
### Custom Rules
In addition to built-in rules, custom rules can be used to address
project-specific requirements. To find community-developed rules use
[keyword `markdownlint-rule` on npm][markdownlint-rule].
To implement your own rules, refer to [CustomRules.md](doc/CustomRules.md).
[markdownlint-rule]: https://www.npmjs.com/search?q=keywords:markdownlint-rule
## Tags ## Tags
Tags group related rules and can be used to enable/disable multiple Tags group related rules and can be used to enable/disable multiple
@ -460,10 +469,7 @@ Type: `Array` of `Object`
List of custom rules to include with the default rule set for linting. List of custom rules to include with the default rule set for linting.
Each array element should define a rule. Rules are typically exported Each array element should define a rule. Rules are typically exported
by another package, but can be defined locally. Custom rules are by another package, but can be defined locally.
identified by the [keyword `markdownlint-rule` on npm][markdownlint-rule].
[markdownlint-rule]: https://www.npmjs.com/search?q=keywords:markdownlint-rule
Example: Example:

View file

@ -7,6 +7,17 @@ rules can and are defined inline or imported from another package ([keyword
`markdownlint-rule` on npm][markdownlint-rule]). Custom rules can be disabled, `markdownlint-rule` on npm][markdownlint-rule]). Custom rules can be disabled,
enabled, and customized using the same syntax as built-in rules. enabled, and customized using the same syntax as built-in rules.
## Implementing Simple Rules
For simple requirements like disallowing certain characters or patterns,
the community-developed
[markdownlint-rule-search-replace][markdownlint-rule-search-replace]
plug-in can be used.
This plug-in allows anyone to create a set of simple text-replacement rules in
JSON without needing to write any code.
[markdownlint-rule-search-replace]: https://www.npmjs.com/package/markdownlint-rule-search-replace
## Authoring ## Authoring
Rules are defined by a name (or multiple names), a description, an optional link Rules are defined by a name (or multiple names), a description, an optional link
@ -85,7 +96,7 @@ properties:
characters to delete (the value `-1` is used to delete the line). characters to delete (the value `-1` is used to delete the line).
- `insertText` is an optional `String` specifying the text to insert. `\n` - `insertText` is an optional `String` specifying the text to insert. `\n`
is the platform-independent way to add a line break; line breaks should is the platform-independent way to add a line break; line breaks should
be added at the beginning of a line instead of at the end). be added at the beginning of a line instead of at the end.
The collection of helper functions shared by the built-in rules is available for The collection of helper functions shared by the built-in rules is available for
use by custom rules in the [markdownlint-rule-helpers package][rule-helpers]. use by custom rules in the [markdownlint-rule-helpers package][rule-helpers].

View file

@ -654,6 +654,7 @@ test("readmeHeadings", (t) => new Promise((resolve) => {
"### Related", "### Related",
"## Demonstration", "## Demonstration",
"## Rules / Aliases", "## Rules / Aliases",
"### Custom Rules",
"## Tags", "## Tags",
"## Configuration", "## Configuration",
"## API", "## API",