Плагины

С помощью Plugin API, плагин VuePress может предоставить вам различные функции.

Плагин сообщества

Пользователи сообщества создали множество плагинов и опубликовали их в NPM. Команда VuePress также поддерживает некоторые официальные плагины в рамках @vuepress. Вы должны проверить собственную документацию плагина для подробного руководства.

Как правило, вам необходимо включить плагин в параметр плагинов, чтобы использовать его. Например, используйте @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()],
};

Вы можете обратиться к Продвинутый > Написание плагина, чтобы узнать, как написать свой собственный плагин.