版本：3.8.1

`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.org.cn',
  // your site config ...
};

docusaurus.config.js
export default async function createConfigAsync() {
  return {
    title: 'Docusaurus',
    url: 'https://docusaurus.org.cn',
    // your site config ...
  };
}

提示

有关更详尽的示例和解释，请参阅声明 docusaurus.config.js 的语法。

必填字段

`title`

类型: string

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

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

`url`

类型: string

您网站的 URL。这也可以认为是顶级主机名。例如，https://fbdocs.cn/metro/ 的 URL 是 https://fbdocs.cn，https://docusaurus.org.cn 的 URL 是 https://docusaurus.org.cn。此字段与 baseUrl 字段相关。

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

`baseUrl`

类型: string

您网站的根 URL。可视为主机名后的路径。例如，/metro/ 是 https://fbdocs.cn/metro/ 的根 URL。对于没有路径的 URL，baseUrl 应设置为 /。此字段与 url 字段相关。始终带有前导斜杠和尾随斜杠。

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

可选字段

`favicon`

类型: string | undefined

您网站 favicon 的路径；必须是可在链接 href 中使用的 URL。例如，如果您的 favicon 在 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="..."> (或任何其他 DOM 标签名) 和 <link ... hreflang="..."> 中使用的 BCP 47 语言标签。
- 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: 移除旧的 plugin.postBuild({head}) API，它阻止我们应用有用的 SSG 优化（解释）。
- useCssCascadeLayers: 这将启用 Docusaurus CSS Cascade Layers 插件，并预配置我们计划在 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: MDX 文件仅编译一次，同时用于浏览器/Node.js 环境，而非两次。
- ssgWorkerThreads: 使用 Node.js worker 线程池更快地执行静态站点生成阶段。需要启用 future.v4.removeLegacyPostBuildHeadAttribute。
experimental_storage: 站点范围的浏览器存储选项，主题作者应努力遵守。
- type: 主题作者应使用的浏览器存储类型。可能的值为 localStorage 和 sessionStorage。默认为 localStorage。
- namespace: 是否对浏览器存储键进行命名空间，以避免 Docusaurus 站点在同一域或本地主机上托管时出现存储键冲突。可能的值为 string | boolean。命名空间附加在存储键 key-namespace 的末尾。使用 true 可从您的站点 url + baseUrl 自动生成一个随机命名空间。默认为 false (无命名空间，历史行为)。
experimental_router: 要使用的路由器类型。可能的值是 browser 和 hash。默认为 browser。hash 路由器仅在您想退出静态站点生成、拥有一个带有单个 index.html 入口文件的完全客户端应用程序的罕见情况下才有用。这对于将 Docusaurus 站点作为 .zip 存档分发非常有用，您可以在不运行 Web 服务器的情况下本地浏览。

`noIndex`

类型: boolean

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

示例

docusaurus.config.js
export default {
  noIndex: true, // Defaults to `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 makes it easy to maintain Open Source documentation websites.',
};

`organizationName`

类型: string

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

docusaurus.config.js
export default {
  // Docusaurus' organization is 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: 'Site Title',
      logo: {
        alt: 'Site Logo',
        src: 'img/logo.svg',
        width: 32,
        height: 32,
      },
      items: [
        {
          to: 'docs/docusaurus.config.js',
          activeBasePath: 'docs',
          label: 'docusaurus.config.js',
          position: 'left',
        },
        // ... other links
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Docs',
          items: [
            {
              label: 'Docs',
              to: 'docs/doc1',
            },
          ],
        },
        // ... other links
      ],
      logo: {
        alt: 'Meta Open Source Logo',
        src: 'img/meta_oss_logo.png',
        href: 'https://opensource.fb.com',
        width: 160,
        height: 51,
      },
      copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`, // You can also put own HTML here
    },
  },
};

`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('Build finished');
      },
    }),
  ],
};

`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; // see 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,
    },
  },
};

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

`customFields`

Docusaurus 保护 docusaurus.config.js 免受未知字段的影响。要添加自定义字段，请在 customFields 上定义它。

类型: Object

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

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

Error: The field(s) 'foo', 'bar' are not recognized in docusaurus.config.js

`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: [
    // String format.
    'https://docusaurus.org.cn/script.js',
    // Object format.
    {
      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: [
    // String format.
    'https://docusaurus.org.cn/style.css',
    // Object format.
    {
      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: '🦖', // Defaults to `|`
};

`baseUrlIssueBanner`

类型: boolean

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

示例

docusaurus.config.js
export default {
  baseUrlIssueBanner: true, // Defaults to `true`
};

A sample base URL issue banner. The style is very raw since the stylesheets failed to load. The text says "Your Docusaurus site did not load properly... Current configured baseUrl = / (default value); We suggest trying baseUrl = /build/

警告

如果所有资产加载因错误的 baseUrl 而失败，此横幅需要内联 CSS/JS。

如果您有严格的内容安全策略 (CSP)，则应禁用此功能。

概述​

必填字段​

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​

概述