mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2026-02-12 08:34:20 +01:00
Add options.markdownItPlugins to support using markdown-it plugins when parsing.
This commit is contained in:
parent
ff86e1d7f1
commit
8a175955d7
5 changed files with 121 additions and 6 deletions
14
README.md
14
README.md
|
|
@ -386,6 +386,20 @@ Passing a `resultVersion` of `2` corresponds to a detailed format where each err
|
|||
includes information about the line number, rule names, description, as well as any
|
||||
additional detail or context that is available. This is the default.
|
||||
|
||||
##### options.markdownItPlugins
|
||||
|
||||
Type: `Array` of `Array` of `Function` and plugin parameters
|
||||
|
||||
Specifies additional [markdown-it plugins](https://www.npmjs.com/search?q=keywords:markdown-it-plugin)
|
||||
to use when parsing input. Plugins can be used to support additional syntax and
|
||||
features for advanced scenarios.
|
||||
|
||||
Each item in the top-level `Array` should be of the form:
|
||||
|
||||
```js
|
||||
[ require("markdown-it-plugin"), plugin_param_0, plugin_param_1, ... ]
|
||||
```
|
||||
|
||||
#### callback
|
||||
|
||||
Type: `Function` taking (`Error`, `Object`)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue