文档简介

文档功能为用户提供了一种以分层格式组织 Markdown 文件的方法。

信息

查看文档插件 API 参考文档以获取所有选项的详尽列表。

您的站点文档由四个级别组织，从低到高：

单个页面。
侧边栏。
版本。
插件实例。

本指南将按此顺序介绍它们：从如何配置单个页面开始，到如何创建单个或多个侧边栏，再到如何创建和管理版本，最后到如何使用多个文档插件实例。

纯文档模式

新初始化的 Docusaurus 站点具有以下结构：

example.com/                                -> 由 `src/pages/index.js` 生成

example.com/docs/intro                      -> 由 `docs/intro.md` 生成
example.com/docs/tutorial-basics/...        -> 由 `docs/tutorial-basics/...` 生成
...

example.com/blog/2021/08/26/welcome         -> 由 `blog/2021-08-26-welcome/index.md` 生成
example.com/blog/2021/08/01/mdx-blog-post   -> 由 `blog/2021-08-01-mdx-blog-post.mdx` 生成
...

所有文档都将在子路由 docs/ 下提供服务。但是，如果 您的站点只有文档 ，或者您想通过将文档放在根目录来优先处理文档，该怎么办？

假设您的配置中包含以下内容：

docusaurus.config.js
export default {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          /* docs 插件选项 */
        },
        blog: {
          /* blog 插件选项 */
        },
        // ...
      },
    ],
  ],
};

要进入纯文档模式，请将其更改为如下所示：

docusaurus.config.js
export default {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          routeBasePath: '/', // 在站点根目录提供文档
          /* 其他文档插件选项 */
        },
        blog: false, // 可选：禁用博客插件
        // ...
      },
    ],
  ],
};

请注意，您 不必一定放弃使用博客 或其他插件；routeBasePath: '/' 所做的只是将文档通过 https://example.com/docs/some-doc 提供服务更改为在站点根目录提供服务：https://example.com/some-doc。如果启用了博客，则仍然可以通过 blog/ 子路由访问博客。

不要忘记通过添加前置 matter 将某个页面放在根目录 (https://example.com/)：

docs/intro.md
---
slug: /
---

访问 https://example.com/ 时，此页面将作为主页。

注意

如果您添加了 slug: / 到文档以使其成为主页，则应删除 ./src/pages/index.js 中现有的主页，否则将有两个文件映射到相同的路由！

现在，站点的结构将如下所示：

example.com/                       -> 由 `docs/intro.md` 生成
example.com/tutorial-basics/...    -> 由 `docs/tutorial-basics/...` 生成
...

提示

对于只想使用 Docusaurus 博客功能的用户，还有一个“纯博客模式”。您可以使用上面详细介绍的相同方法。请按照纯博客模式上的设置说明进行操作。

纯文档模式​

纯文档模式