Add example for markdownlint-rule-helpers.applyFixes to documentation (fixes #663).

This commit is contained in:
Bryan Mishkin 2022-12-03 15:48:08 -05:00 committed by David Anson
parent 09911b24cf
commit 2c38ae90fc
3 changed files with 24 additions and 1 deletions

View file

@ -928,6 +928,14 @@ bad.md: 1: MD041/first-line-heading/first-line-h1 First line in a file should be
<!-- markdownlint-restore -->
### Fixing
Rules that can be fixed automatically include a `fixInfo` property which is
outlined in the [documentation for custom rules](doc/CustomRules.md#authoring).
To apply those fixes more easily, the `applyFixes` method in
[markdownlint-rule-helpers](helpers/README.md#applying-recommended-fixes) may
be used.
## Browser
`markdownlint` also works in the browser.