静态方法

静态方法不是插件实例的一部分——它们附加到构造函数上。这些方法用于验证和规范化插件选项和主题配置，然后作为构造函数参数用于初始化插件实例。

validateOptions({options, validate})​

返回经过验证和标准化的插件选项。此方法在插件初始化之前调用。您必须返回这些选项，因为它们将在初始化期间传递给插件。

options​

validateOptions 被调用时，会传入 options 给插件进行验证和规范化。

validate​

validateOptions 使用 validate 函数调用，该函数接受一个 Joi 模式和选项作为参数，返回经过验证和标准化的选项。validate 将自动处理错误和验证配置。

如果你不使用Joi进行验证，你可以在选项无效时抛出错误，并在成功时返回选项。

export default function myPlugin(context, options) {
  return {
    name: 'docusaurus-plugin',
    // rest of methods
  };
}

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

validateThemeConfig({themeConfig, validate})​

返回经过验证和规范化的主题配置。

themeConfig​

validateThemeConfig 在 docusaurus.config.js 中提供的 themeConfig 被调用以进行验证和规范化。

validate​

validateThemeConfig 使用 validate 函数调用，该函数接受一个 Joi 模式和 themeConfig 作为参数，返回经过验证和规范化的选项。validate 将自动处理错误和验证配置。

如果你不使用Joi进行验证，你可以在选项无效时抛出一个错误。

export default function myPlugin(context, options) {
  return {
    name: 'docusaurus-plugin',
    // rest of methods
  };
}

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