插件

借助于 插件 API , VuePress 插件可以为你提供各种不同的功能。

社区插件

社区用户创建了很多插件,并将它们发布到了 NPM在新窗口打开 上。 VuePress 团队也在 @vuepress在新窗口打开 Scope 下维护了一些官方插件。查看插件本身的文档可以获取更详细的指引。

一般而言,你需要将插件放入到 plugins 配置项中来使用它。举例来说,你可以使用 @vuepress/plugin-google-analytics 来使用 Google Analytics :

import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics'

export default {
  plugins: [
    googleAnalyticsPlugin({
      id: 'G-XXXXXXXXXX'
    }),
  ],
}

提示

大部分插件只能使用一次,如果同一个插件被多次使用,那么只有最后一次会生效。

然而,部分插件是可以被多次使用的(例如 @vuepress/plugin-container),你应该查看插件本身的文档来获取详细指引。

本地插件

如果你想要使用自己的插件,但是又不想发布它,你可以创建一个本地插件。

我们推荐你直接将 配置文件 作为插件使用,因为 几乎所有的插件 API 都可以在配置文件中使用,这在绝大多数场景下都更为方便。

但是如果你在配置文件中要做的事情太多了,你可以考虑将它们提取到单独的插件中,然后在你的配置文件中使用它们:

import myPlugin from './path/to/my-plugin.js'

export default {
  plugins: [
    myPlugin(),
  ],
}

前往 深入 > 开发插件 学习如何开发你自己的插件。