Skip to content

Commit

Permalink
refactor(markdown): externalize custom component plugin
Browse files Browse the repository at this point in the history
BREAKING CHANGE: `markdown.customComponent` has been renamed to `markdown.component`
  • Loading branch information
meteorlxy committed Jun 22, 2022
1 parent 943260f commit a1909c0
Show file tree
Hide file tree
Showing 16 changed files with 23 additions and 1,129 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Expand Up @@ -26,6 +26,7 @@
"frontmatter",
"globby",
"gtag",
"mdit",
"nprogress",
"prefetch",
"preload",
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/config.md
Expand Up @@ -461,13 +461,13 @@ You can disable it if you want to implement them in client side. For example, [P
- Also see:
- [Guide > Markdown > Syntax Extensions > Code Blocks > Wrap with v-pre](../guide/markdown.md#wrap-with-v-pre)

### markdown.customComponent
### markdown.component

- Type: `undefined | false`

- Details:

Options for VuePress built-in markdown-it custom-component plugin.
Options for [@mdit-vue/plugin-component](https://www.npmjs.com/package/@mdit-vue/plugin-component).

Set to `false` to disable this plugin.

Expand Down
4 changes: 2 additions & 2 deletions docs/zh/reference/config.md
Expand Up @@ -460,13 +460,13 @@ VuePress 在开发和构建时会加载临时文件,因此临时文件目录
- 参考:
- [指南 > Markdown > 语法扩展 > 代码块 > 添加 v-pre](../guide/markdown.md#添加-v-pre)

### markdown.customComponent
### markdown.component

- 类型: `undefined | false`

- 详情:

VuePress 内置的 markdown-it custom-component 插件的配置项。
[@mdit-vue/plugin-component](https://www.npmjs.com/package/@mdit-vue/plugin-component) 插件的配置项。

设置为 `false` 可以禁用该插件。

Expand Down

0 comments on commit a1909c0

Please sign in to comment.