Skip to content

Commit 89d8a7a

Browse files
committed
docs: markdown.config to markdown.extendMarkdown (close: #885)
1 parent bd7d17d commit 89d8a7a

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

packages/docs/docs/config/README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -179,24 +179,28 @@ Options for [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-
179179

180180
Options for [markdown-it-table-of-contents](https://github.com/Oktavilla/markdown-it-table-of-contents). (Note: prefer `markdown.slugify` if you want to customize header ids.)
181181

182-
### markdown.config
182+
### markdown.extendMarkdown
183183

184184
- Type: `Function`
185185
- Default: `undefined`
186186

187-
A function to modify default config or apply additional plugins to the [markdown-it](https://github.com/markdown-it/markdown-it) instance used to render source files. Example:
187+
A function to modify default config or apply additional plugins to the [markdown-it](https://github.com/markdown-it/markdown-it) instance used to render source files. e.g.
188188

189189
``` js
190190
module.exports = {
191191
markdown: {
192-
config: md => {
192+
extendMarkdown: md => {
193193
md.set({ breaks: true })
194194
md.use(require('markdown-it-xxx'))
195195
}
196196
}
197197
}
198198
```
199199

200+
::: tip
201+
This option is also included in [Plugin API](../plugin/README.md#extendmarkdown).
202+
:::
203+
200204
## Build Pipeline
201205

202206
### postcss

0 commit comments

Comments
 (0)