`docusaurus.config.js`

信息

请参考入门指南中的配置部分获取示例。

概述

docusaurus.config.js 包含站点的配置，并放置在站点的根目录中。

备注

对于 TypeScript Docusaurus 代码库，您的配置文件可能被命名为 docusaurus.config.ts。语法与 js 配置文件基本相同，并增加了类型。您可以在 Docusaurus 网站本身查看一个示例。

此文件在 Node.js 中运行，并应导出站点配置对象，或创建该对象的函数。

docusaurus.config.js 文件支持：

示例：

docusaurus.config.js
export default {
  title: 'Docusaurus',
  url: 'https://docusaurus.io',
  // 您的站点配置 ...
};

docusaurus.config.js
export default async function createConfigAsync() {
  return {
    title: 'Docusaurus',
    url: 'https://docusaurus.io',
    // 您的站点配置 ...
  };
}

提示

请参考声明 docusaurus.config.js 的语法以获取更详尽的示例和解释。

必填字段

`title`

类型：string

您网站的标题。将用于元数据和浏览器标签标题。

docusaurus.config.js
export default {
  title: 'Docusaurus',
};

`url`

类型：string

您网站的 URL。这也可以被视为顶级主机名。例如，https://facebook.github.io 是 https://facebook.github.io/metro/ 的 URL，https://docusaurus.io 是 https://docusaurus.io 的 URL。此字段与 baseUrl 字段相关。

docusaurus.config.js
export default {
  url: 'https://docusaurus.io',
};

`baseUrl`

类型：string

您站点的基本 URL。可以被视为主机后的路径。例如，/metro/ 是 https://facebook.github.io/metro/ 的基本 URL。对于没有路径的 URL，baseUrl 应设置为 /。此字段与 url 字段相关。始终具有前导和尾随斜杠。

docusaurus.config.js
export default {
  baseUrl: '/',
};

可选字段

`favicon`

类型：string | undefined

您站点的网站图标路径；必须是可在链接的 href 中使用的 URL。例如，如果您的网站图标在 static/img/favicon.ico：

docusaurus.config.js
export default {
  favicon: '/img/favicon.ico',
};

`trailingSlash`

类型：boolean | undefined

允许自定义 URL/链接末尾尾随斜杠的存在/不存在，以及如何生成静态 HTML 文件：

undefined（默认）：保持 URL 不变，并为 /docs/myDoc.md 生成 /docs/myDoc/index.html
true：为 URL/链接添加尾随斜杠，并为 /docs/myDoc.md 生成 /docs/myDoc/index.html
false：从 URL/链接中删除尾随斜杠，并为 /docs/myDoc.md 生成 /docs/myDoc.html

提示

每个静态托管提供商以不同的方式提供静态文件（此行为可能随时间变化）。

请参考部署指南和 slorber/trailing-slash-guide以选择适当的设置。

`i18n`

类型：Object

用于本地化您的站点的 i18n 配置对象。

示例：

docusaurus.config.js
export default {
  i18n: {
    defaultLocale: 'en',
    locales: ['en', 'fa'],
    path: 'i18n',
    localeConfigs: {
      en: {
        label: 'English',
        direction: 'ltr',
        htmlLang: 'en-US',
        calendar: 'gregory',
        path: 'en',
      },
      fa: {
        label: 'فارسی',
        direction: 'rtl',
        htmlLang: 'fa-IR',
        calendar: 'persian',
        path: 'fa',
      },
    },
  },
};

defaultLocale：语言环境（1）在基本 URL 中不显示名称（2）在不带 --locale 选项的 docusaurus start 中启动（3）将用于 <link hrefLang="x-default"> 标签
locales：部署在您站点上的语言环境列表。必须包含 defaultLocale。
path：所有语言环境文件夹相对的根文件夹。可以是绝对路径或相对于配置文件的路径。默认为 i18n。
localeConfigs：每个语言环境的单独选项。
- label：在语言环境下拉菜单中为此语言环境显示的标签。
- direction：ltr（默认）或 rtl（对于从右到左的语言，如波斯语、阿拉伯语、希伯来语等）。用于选择语言环境的 CSS 和 HTML 元属性。
- htmlLang：在 <html lang="..."> 中使用的 BCP 47 语言标签（或任何其他 DOM 标签名称）和 <link ... hreflang="...">
- calendar：用于计算日期纪元的日历。请注意，它不控制实际显示的字符串：MM/DD/YYYY 和 DD/MM/YYYY 都是 gregory。要选择格式（DD/MM/YYYY 或 MM/DD/YYYY），请将语言环境名称设置为 en-GB 或 en-US（en 表示 en-US）。
- path：此语言环境的所有插件本地化文件夹的根文件夹。将根据 i18n.path 解析。默认为语言环境的名称。注意：这不会影响语言环境的 baseUrl——基本 URL 的自定义是一项正在进行的工作。

`future`

类型：Object

future 配置对象允许选择即将到来/不稳定/实验性的 Docusaurus 功能，这些功能尚未准备好投入使用。

这也是一种选择即将到来的重大更改的方式，使您能够在仍使用前一个版本的同时为下一个版本做准备。Remix Future Flags 博客文章很好地解释了这个想法。

在次要版本中的重大更改

以 experimental_ 或 unstable_ 为前缀的功能可能在次要版本中发生变化，并且不被视为语义版本控制重大更改。

由 v<MajorVersion> 命名空间的功能（v6、v7 等）是预期在下一个主要版本中默认启用的未来标志。这些不太可能更改，但我们保留这样做的可能性。

future API 重大更改应该很容易处理，并将在次要/主要版本博客文章中记录。

示例：

docusaurus.config.js
export default {
  future: {
    v4: {
      removeLegacyPostBuildHeadAttribute: true,
      useCssCascadeLayers: true,
    },
    experimental_faster: {
      swcJsLoader: true,
      swcJsMinimizer: true,
      swcHtmlMinimizer: true,
      lightningCssMinimizer: true,
      rspackBundler: true,
      rspackPersistentCache: true,
      ssgWorkerThreads: true,
      mdxCrossCompilerCache: true,
    },
    experimental_storage: {
      type: 'localStorage',
      namespace: true,
    },
    experimental_router: 'hash',
  },
};

v4：允许选择即将到来的 Docusaurus v4 重大更改和功能，以提前为这个新版本准备您的站点。使用 true 作为启用所有标志的快捷方式。
- removeLegacyPostBuildHeadAttribute：删除阻止我们应用有用的 SSG 优化的旧 plugin.postBuild({head}) API（解释）。
- useCssCascadeLayers：这启用了Docusaurus CSS 级联层插件，并预配置了我们计划在 Docusaurus v4 中默认应用的层。
experimental_faster：一个包含功能标志的对象，用于加快 Docusaurus 构建速度。这需要将 @docusaurus/faster 包添加到您站点的依赖项中。使用 true 作为启用所有标志的快捷方式。在 Docusaurus Faster 问题上阅读更多内容。可用的功能标志：
- swcJsLoader：使用 SWC 转译 JS（而不是 Babel）。
- swcJsMinimizer：使用 SWC 压缩 JS（而不是 Terser）。
- swcHtmlMinimizer：使用 SWC 压缩 HTML 和内联 JS/CSS（而不是 html-minifier-terser）。
- lightningCssMinimizer：使用 Lightning CSS 压缩 CSS（而不是 cssnano 和 clean-css）。
- rspackBundler：使用 Rspack 打包您的应用（而不是 webpack）。
- rspackPersistentCache：使用 Rspack 持久缓存在后续构建中更快地重新构建您的应用。需要 rspackBundler: true。需要在重建之间保留 ./node_modules/.cache。
- mdxCrossCompilerCache：为浏览器/Node.js 环境编译 MDX 文件，而不是两次。
- ssgWorkerThreads：使用 Node.js 工作线程池更快地执行静态站点生成阶段。需要打开 future.v4.removeLegacyPostBuildHeadAttribute。
experimental_storage：主题作者应该尊重的站点范围的浏览器存储选项。
- type：主题作者应该使用的浏览器存储。可能的值是 localStorage 和 sessionStorage。默认为 localStorage。
- namespace：是否对浏览器存储键进行命名空间，以避免在同一域下或本地主机上托管 Docusaurus 站点时的存储键冲突。可能的值是 string | boolean。命名空间附加在存储键 key-namespace 的末尾。使用 true 从您的站点 url + baseUrl 自动生成随机命名空间。默认为 false（无命名空间，历史行为）。
experimental_router：要使用的路由器类型。可能的值是 browser 和 hash。默认为 browser。仅在您希望选择退出静态站点生成、拥有完全客户端应用和单个 index.html 入口点文件的罕见情况下，hash 路由器才有用。这可用于分发 Docusaurus 站点作为 .zip 存档，您可以在不运行 Web 服务器的情况下本地浏览。

`noIndex`

类型：boolean

此选项在每个页面上添加 <meta name="robots" content="noindex, nofollow"> 以告诉搜索引擎避免索引您的站点（更多信息在此）。

示例：

docusaurus.config.js
export default {
  noIndex: true, // 默认为 `false`
};

`onBrokenLinks`

类型：'ignore' | 'log' | 'warn' | 'throw'

Docusaurus 检测到任何断开的链接时的行为。

默认情况下，它会抛出错误，以确保您不会发布任何断开的链接。

备注

断开的链接检测仅在生产构建（docusaurus build）中可用。

`onBrokenAnchors`

类型：'ignore' | 'log' | 'warn' | 'throw'

Docusaurus 检测到使用 Docusaurus 的 Heading 组件声明的任何断开锚点时的行为。

默认情况下，它会打印警告，让您知道断开的锚点。

`onBrokenMarkdownLinks`

类型：'ignore' | 'log' | 'warn' | 'throw'

Docusaurus 检测到任何断开的 Markdown 链接时的行为。

默认情况下，它会打印警告，让您知道断开的 Markdown 链接。

`onDuplicateRoutes`

类型：'ignore' | 'log' | 'warn' | 'throw'

Docusaurus 检测到任何重复路由时的行为。

默认情况下，在您运行 yarn start 或 yarn build 后会显示警告。

`tagline`

类型：string

您网站的标语。

docusaurus.config.js
export default {
  tagline:
    'Docusaurus 使维护开源文档网站变得简单。',
};

`organizationName`

类型：string

拥有仓库的 GitHub 用户或组织。如果您不使用 docusaurus deploy 命令，则不需要此项。

docusaurus.config.js
export default {
  // Docusaurus 的组织是 facebook
  organizationName: 'facebook',
};

`projectName`

类型：string

GitHub 仓库的名称。如果您不使用 docusaurus deploy 命令，则不需要此项。

docusaurus.config.js
export default {
  projectName: 'docusaurus',
};

`deploymentBranch`

类型：string

要部署静态文件的分支名称。如果您不使用 docusaurus deploy 命令，则不需要此项。

docusaurus.config.js
export default {
  deploymentBranch: 'gh-pages',
};

`githubHost`

类型：string

服务器的主机名。如果您使用 GitHub Enterprise，这很有用。如果您不使用 docusaurus deploy 命令，则不需要此项。

docusaurus.config.js
export default {
  githubHost: 'github.com',
};

`githubPort`

类型：string

服务器的端口。如果您使用 GitHub Enterprise，这很有用。如果您不使用 docusaurus deploy 命令，则不需要此项。

docusaurus.config.js
export default {
  githubPort: '22',
};

`themeConfig`

类型：Object

用于自定义站点 UI（如导航栏和页脚）的主题配置对象。

示例：

docusaurus.config.js
export default {
  themeConfig: {
    docs: {
      sidebar: {
        hideable: false,
        autoCollapseCategories: false,
      },
    },
    colorMode: {
      defaultMode: 'light',
      disableSwitch: false,
      respectPrefersColorScheme: true,
    },
    navbar: {
      title: '站点标题',
      logo: {
        alt: '站点徽标',
        src: 'img/logo.svg',
        width: 32,
        height: 32,
      },
      items: [
        {
          to: 'docs/docusaurus.config.js',
          activeBasePath: 'docs',
          label: 'docusaurus.config.js',
          position: 'left',
        },
        // ... 其他链接
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: '文档',
          items: [
            {
              label: '文档',
              to: 'docs/doc1',
            },
          ],
        },
        // ... 其他链接
      ],
      logo: {
        alt: 'Meta 开源徽标',
        src: 'img/meta_oss_logo.png',
        href: 'https://opensource.fb.com',
        width: 160,
        height: 51,
      },
      copyright: `版权所有 © ${new Date().getFullYear()} Facebook, Inc.`, // 您也可以在此处放置自己的 HTML
    },
  },
};

`plugins`

类型：PluginConfig[]

type PluginConfig = string | [string, any] | PluginModule | [PluginModule, any];

请参见插件方法参考以了解 PluginModule 的形状。

docusaurus.config.js
export default {
  plugins: [
    'docusaurus-plugin-awesome',
    ['docusuarus-plugin-confetti', {fancy: false}],
    () => ({
      postBuild() {
        console.log('构建完成');
      },
    }),
  ],
};

`themes`

类型：PluginConfig[]

docusaurus.config.js
export default {
  themes: ['@docusaurus/theme-classic'],
};

`presets`

类型：PresetConfig[]

type PresetConfig = string | [string, any];

docusaurus.config.js
export default {
  presets: [],
};

`markdown`

全局 Docusaurus Markdown 配置。

类型：MarkdownConfig

type MarkdownPreprocessor = (args: {
  filePath: string;
  fileContent: string;
}) => string;

type MDX1CompatOptions =
  | boolean
  | {
      comments: boolean;
      admonitions: boolean;
      headingIds: boolean;
    };

export type ParseFrontMatter = (params: {
  filePath: string;
  fileContent: string;
  defaultParseFrontMatter: ParseFrontMatter;
}) => Promise<{
  frontMatter: {[key: string]: unknown};
  content: string;
}>;

type MarkdownAnchorsConfig = {
  maintainCase: boolean;
};

type MarkdownConfig = {
  format: 'mdx' | 'md' | 'detect';
  mermaid: boolean;
  preprocessor?: MarkdownPreprocessor;
  parseFrontMatter?: ParseFrontMatter;
  mdx1Compat: MDX1CompatOptions;
  remarkRehypeOptions: object; // 参见 https://github.com/remarkjs/remark-rehype#options
  anchors: MarkdownAnchorsConfig;
};

示例：

docusaurus.config.js
export default {
  markdown: {
    format: 'mdx',
    mermaid: true,
    preprocessor: ({filePath, fileContent}) => {
      return fileContent.replaceAll('{{MY_VAR}}', 'MY_VALUE');
    },
    parseFrontMatter: async (params) => {
      const result = await params.defaultParseFrontMatter(params);
      result.frontMatter.description =
        result.frontMatter.description?.replaceAll('{{MY_VAR}}', 'MY_VALUE');
      return result;
    },
    mdx1Compat: {
      comments: true,
      admonitions: true,
      headingIds: true,
    },
    anchors: {
      maintainCase: true,
    },
  },
};

名称	类型	默认值	描述
`format`	`'mdx' \| 'md' \| 'detect'`	`'mdx'`	用于 Markdown 内容的默认解析器格式。使用 'detect' 将根据文件扩展名自动选择适当的格式：`.md` 与 `.mdx`。
`mermaid`	`boolean`	`false`	当为 `true` 时，允许 Docusaurus 将语言为 `mermaid` 的 Markdown 代码块渲染为 Mermaid 图表。
`preprocessor`	`MarkdownPreprocessor`	`undefined`	使您能够在解析之前更改 Markdown 内容字符串。将其作为最后的逃生舱口或解决方法使用：几乎总是更好地实现 Remark/Rehype 插件。
`parseFrontMatter`	`ParseFrontMatter`	`undefined`	使您能够提供自己的前置元数据解析器，或增强默认解析器。请阅读我们的前置元数据指南以获取详细信息。
`mdx1Compat`	`MDX1CompatOptions`	`{comments: true, admonitions: true, headingIds: true}`	使升级到 Docusaurus v3+ 更容易的兼容性选项。
`anchors`	`MarkdownAnchorsConfig`	`{maintainCase: false}`	控制从 Markdown 标题生成的锚点行为的选项
`remarkRehypeOptions`	`object`	`undefined`	使传递自定义 `remark-rehype` 选项成为可能。

`customFields`

Docusaurus 会阻止 docusaurus.config.js 中的未知字段。要添加自定义字段，请在 customFields 上定义。

类型：Object

docusaurus.config.js
export default {
  customFields: {
    admin: 'endi',
    superman: 'lol',
  },
};

尝试在配置中添加未知字段将导致构建时错误：

错误：在 docusaurus.config.js 中无法识别字段 'foo'、'bar'

`staticDirectories`

相对于站点目录或绝对路径的路径数组。这些路径下的文件将原样复制到构建输出。

类型：string[]

示例：

docusaurus.config.js
export default {
  staticDirectories: ['static'],
};

`headTags`

将插入 HTML <head> 中的标签数组。值必须是包含两个属性的对象：tagName 和 attributes。tagName 必须是一个确定要创建的标签的字符串；例如 "link"。attributes 必须是属性-值映射。

类型：{ tagName: string; attributes: Object; }[]

示例：

docusaurus.config.js
export default {
  headTags: [
    {
      tagName: 'link',
      attributes: {
        rel: 'icon',
        href: '/img/docusaurus.png',
      },
    },
  ],
};

这将在生成的 HTML 中变为 <link rel="icon" href="img/docusaurus.png" />。

`scripts`

要加载的脚本数组。值可以是字符串或属性-值映射的普通对象。<script> 标签将插入 HTML <head> 中。如果使用普通对象，唯一需要的属性是 src，并且允许任何其他属性（每个属性应具有布尔/字符串值）。

请注意，此处添加的 <script> 是阻塞渲染的，因此您可能想添加 async: true/defer: true 到对象中。

类型：(string | Object)[]

示例：

docusaurus.config.js
export default {
  scripts: [
    // 字符串格式。
    'https://docusaurus.io/script.js',
    // 对象格式。
    {
      src: 'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
      async: true,
    },
  ],
};

`stylesheets`

要加载的 CSS 源数组。值可以是字符串或属性-值映射的普通对象。<link> 标签将插入 HTML <head> 中。如果使用对象，唯一需要的属性是 href，并且允许任何其他属性（每个属性应具有布尔/字符串值）。

类型：(string | Object)[]

示例：

docusaurus.config.js
export default {
  stylesheets: [
    // 字符串格式。
    'https://docusaurus.io/style.css',
    // 对象格式。
    {
      href: 'http://mydomain.com/style.css',
    },
  ],
};

信息

默认情况下，<link> 标签将具有 rel="stylesheet"，但您可以显式添加自定义 rel 值以注入任何类型的 <link> 标签，不仅仅是样式表。

`clientModules`

要在站点全局加载的客户端模块数组。

示例：

docusaurus.config.js
export default {
  clientModules: ['./mySiteGlobalJs.js', './mySiteGlobalCss.css'],
};

`ssrTemplate`

使用 Eta 语法编写的 HTML 模板，将用于渲染您的应用程序。这可用于在 body 标签上设置自定义属性、添加额外的 meta 标签、自定义 viewport 等。请注意，Docusaurus 依赖模板正确构建以正常运行，一旦您自定义它，您将必须确保您的模板符合上游的要求。

类型：string

示例：

docusaurus.config.js
export default {
  ssrTemplate: `<!DOCTYPE html>
<html <%~ it.htmlAttributes %>>
  <head>
    <meta charset="UTF-8">
    <meta name="generator" content="Docusaurus v<%= it.version %>">
    <% it.metaAttributes.forEach((metaAttribute) => { %>
      <%~ metaAttribute %>
    <% }); %>
    <%~ it.headTags %>
    <% it.stylesheets.forEach((stylesheet) => { %>
      <link rel="stylesheet" href="<%= it.baseUrl %><%= stylesheet %>" />
    <% }); %>
    <% it.scripts.forEach((script) => { %>
      <link rel="preload" href="<%= it.baseUrl %><%= script %>" as="script">
    <% }); %>
  </head>
  <body <%~ it.bodyAttributes %>>
    <%~ it.preBodyTags %>
    <div id="__docusaurus">
      <%~ it.appHtml %>
    </div>
    <% it.scripts.forEach((script) => { %>
      <script src="<%= it.baseUrl %><%= script %>"></script>
    <% }); %>
    <%~ it.postBodyTags %>
  </body>
</html>`,
};

`titleDelimiter`

类型：string

将在生成的 <title> 标签中用作标题分隔符。

示例：

docusaurus.config.js
export default {
  titleDelimiter: '🦖', // 默认为 `|`
};

`baseUrlIssueBanner`

类型：boolean

启用后，如果您的站点无法加载其 CSS 或 JavaScript 文件，将显示一个横幅，这是一个非常常见的问题，通常与站点配置中的错误 baseUrl 有关。

示例：

docusaurus.config.js
export default {
  baseUrlIssueBanner: true, // 默认为 `true`
};

一个基本 URL 问题横幅的示例。由于样式表未加载，样式非常原始。文本显示"您的 Docusaurus 站点未正确加载...当前配置的 baseUrl = /（默认值）；我们建议尝试 baseUrl = /build/"

注意

此横幅需要内联 CSS / JS，以防由于错误的基本 URL 导致所有资源加载失败。

如果您有严格的内容安全策略，您应该禁用它。

概述​

必填字段​

title​

url​

baseUrl​

可选字段​

favicon​

trailingSlash​

i18n​

future​

noIndex​

onBrokenLinks​

onBrokenAnchors​

onBrokenMarkdownLinks​

onDuplicateRoutes​

tagline​

organizationName​

projectName​

deploymentBranch​

githubHost​

githubPort​

themeConfig​

plugins​

themes​

presets​

markdown​

customFields​

staticDirectories​

headTags​

scripts​

stylesheets​

clientModules​

ssrTemplate​

titleDelimiter​

baseUrlIssueBanner​

概述