プラグインメソッドのリファレンス

警告

このセクションは開発中です。アンカーリンクやURLでさえ、安定することは保証されていません。

プラグインAPIはテーマとプラグインで共有されます。テーマはプラグインと同じようにロードされます。

プラグインモジュール

すべてのプラグインはモジュールとしてインポートされます。モジュールには以下のメンバーがあることが期待されます。

• デフォルトエクスポート：プラグインのコンストラクター関数。
• 名前付きエクスポート：プラグインが初期化される前に呼び出される静的メソッド。

プラグインコンストラクター

プラグインモジュールのデフォルトエクスポートは、シグネチャが(context: LoadContext, options: PluginOptions) => Plugin | Promise<Plugin>のコンストラクター関数です。

context

contextはプラグインに依存せず、Docusaurus Webサイトで使用されるすべてのプラグインに同じオブジェクトが渡されます。contextオブジェクトには、次のフィールドが含まれています。

type LoadContext = {
  siteDir: string;
  generatedFilesDir: string;
  siteConfig: DocusaurusConfig;
  outDir: string;
  baseUrl: string;
};

options

optionsは、プラグインを使用する際の2番目のオプションパラメーターです。optionsはプラグイン固有であり、ユーザーがdocusaurus.config.jsで使用するときに指定されます。validateOptions関数がエクスポートされている場合、optionsは事前に検証および正規化されます。

または、プリセットにプラグインが含まれている場合、プリセットがプラグインに正しいオプションを渡す役割を担います。どのようなオプションを受け入れるかは、個々のプラグインによって定義されます。

例

これは、推測に基づくプラグイン実装のメンタルモデルです。

// A JavaScript function that returns an object.
// `context` is provided by Docusaurus. Example: siteConfig can be accessed from context.
// `opts` is the user-defined options.
export default async function myPlugin(context, opts) {
  return {
    // A compulsory field used as the namespace for directories to cache
    // the intermediate data for each plugin.
    // If you're writing your own local plugin, you will want it to
    // be unique in order not to potentially conflict with imported plugins.
    // A good way will be to add your own project name within.
    name: 'docusaurus-my-project-cool-plugin',

    async loadContent() {
      // The loadContent hook is executed after siteConfig and env has been loaded.
      // You can return a JavaScript object that will be passed to contentLoaded hook.
    },

    async contentLoaded({content, actions}) {
      // The contentLoaded hook is done after loadContent hook is done.
      // `actions` are set of functional API provided by Docusaurus (e.g. addRoute)
    },

    async postBuild(props) {
      // After docusaurus <build> finish.
    },

    // TODO
    async postStart(props) {
      // docusaurus <start> finish
    },

    // TODO
    afterDevServer(app, server) {
      // https://webpack.dokyumento.jp/configuration/dev-server/#devserverbefore
    },

    // TODO
    beforeDevServer(app, server) {
      // https://webpack.dokyumento.jp/configuration/dev-server/#devserverafter
    },

    configureWebpack(config, isServer, utils, content) {
      // Modify internal webpack config. If returned value is an Object, it
      // will be merged into the final config using webpack-merge;
      // If the returned value is a function, it will receive the config as the 1st argument and an isServer flag as the 2nd argument.
    },

    getPathsToWatch() {
      // Paths to watch.
    },

    getThemePath() {
      // Returns the path to the directory where the theme components can
      // be found.
    },

    getClientModules() {
      // Return an array of paths to the modules that are to be imported
      // in the client bundle. These modules are imported globally before
      // React even renders the initial UI.
    },

    extendCli(cli) {
      // Register an extra command to enhance the CLI of Docusaurus
    },

    injectHtmlTags({content}) {
      // Inject head and/or body HTML tags.
    },

    async getTranslationFiles({content}) {
      // Return translation files
    },

    translateContent({content, translationFiles}) {
      // translate the plugin content here
    },

    translateThemeConfig({themeConfig, translationFiles}) {
      // translate the site themeConfig here
    },

    async getDefaultCodeTranslationMessages() {
      // return default theme translations here
    },
  };
}

export function validateOptions({options, validate}) {
  const validatedOptions = validate(myValidationSchema, options);
  return validatedOptions;
}

export function validateThemeConfig({themeConfig, validate}) {
  const validatedThemeConfig = validate(myValidationSchema, options);
  return validatedThemeConfig;
}