📦 plugin-client-redirects

Docusaurus 插件，用于生成**客户端重定向**。

此插件会将额外的 HTML 页面写入您的静态站点，以便使用 JavaScript 将用户重定向到您现有的 Docusaurus 页面。

仅限生产环境

此插件在开发环境中始终处于非活动状态，并且**仅在生产环境中处于活动状态**，因为它作用于构建输出。

警告

尽可能使用服务器端重定向。

在使用此插件之前，您应该查看您的托管服务提供商是否提供此功能。

安装

npm

npm install --save @docusaurus/plugin-client-redirects

Yarn

yarn add @docusaurus/plugin-client-redirects

pnpm

pnpm add @docusaurus/plugin-client-redirects

配置

可接受的字段

选项	类型	默认值	描述
fromExtensions	string[]	[]	重定向后要从路由中删除的扩展名。
toExtensions	string[]	[]	重定向后要追加到路由的扩展名。
redirects	RedirectRule[]	[]	重定向规则列表。
createRedirects	CreateRedirectsFn	undefined	用于创建重定向规则的回调函数。Docusaurus 会针对其创建的每个路径查询此回调函数，并使用其返回值输出更多路径。

注意

此插件还会读取siteConfig.onDuplicateRoutes 配置，以便在将多个文件输出到同一位置时调整其日志级别。

类型

RedirectRule

type RedirectRule = {
  to: string;
  from: string | string[];
};

注意

"from" 和 "to" 的概念在此插件中至关重要。"From" 表示您想要创建的路径，即要写入的额外 HTML 文件；"to" 表示您想要重定向到的路径，通常是 Docusaurus 已经知道的路由。

这就是为什么您可以为同一个 "to" 设置多个 "from" 的原因：我们将创建多个 HTML 文件，它们都重定向到同一个目标。另一方面，一个 "from" 永远不能有多个 "to"：写入的 HTML 文件需要有一个确定的目标。

CreateRedirectsFn

// The parameter `path` is a route that Docusaurus has already created. It can
// be seen as the "to", and your return value is the "from". Returning a falsy
// value will not create any redirect pages for this particular path.
type CreateRedirectsFn = (path: string) => string[] | string | null | undefined;

示例配置

这是一个示例配置

docusaurus.config.js

export default {
  plugins: [
    [
      '@docusaurus/plugin-client-redirects',
      {
        fromExtensions: ['html', 'htm'], // /myPage.html -> /myPage
        toExtensions: ['exe', 'zip'], // /myAsset -> /myAsset.zip (if latter exists)
        redirects: [
          // /docs/oldDoc -> /docs/newDoc
          {
            to: '/docs/newDoc',
            from: '/docs/oldDoc',
          },
          // Redirect from multiple old paths to the new path
          {
            to: '/docs/newDoc2',
            from: ['/docs/oldDocFrom2019', '/docs/legacyDocFrom2016'],
          },
        ],
        createRedirects(existingPath) {
          if (existingPath.includes('/community')) {
            // Redirect from /docs/team/X to /community/X and /docs/support/X to /community/X
            return [
              existingPath.replace('/community', '/docs/team'),
              existingPath.replace('/community', '/docs/support'),
            ];
          }
          return undefined; // Return a falsy value: no redirect created
        },
      },
    ],
  ],
};