You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/docs/docs/config/README.md
+7-3
Original file line number
Diff line number
Diff line change
@@ -179,24 +179,28 @@ Options for [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-
179
179
180
180
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.)
181
181
182
-
### markdown.config
182
+
### markdown.extendMarkdown
183
183
184
184
- Type: `Function`
185
185
- Default: `undefined`
186
186
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.
188
188
189
189
```js
190
190
module.exports= {
191
191
markdown: {
192
-
config:md=> {
192
+
extendMarkdown:md=> {
193
193
md.set({ breaks:true })
194
194
md.use(require('markdown-it-xxx'))
195
195
}
196
196
}
197
197
}
198
198
```
199
199
200
+
::: tip
201
+
This option is also included in [Plugin API](../plugin/README.md#extendmarkdown).
0 commit comments