文档简介

文档功能为用户提供了以层级结构组织 Markdown 文件的方式。

提示

请查阅文档插件 API 参考文档以获取完整的选项列表。

你站点的文档按四个层级组织，从低到高分别是：

1. 独立页面。
2. 侧边栏。
3. 版本。
4. 插件实例。

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

纯文档模式

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

example.com/                                -> generated from `src/pages/index.js`

example.com/docs/intro                      -> generated from `docs/intro.md`
example.com/docs/tutorial-basics/...        -> generated from `docs/tutorial-basics/...`
...

example.com/blog/2021/08/26/welcome         -> generated from `blog/2021-08-26-welcome/index.md`
example.com/blog/2021/08/01/mdx-blog-post   -> generated from `blog/2021-08-01-mdx-blog-post.mdx`
...

所有文档都将在子路由 docs/ 下提供服务。但如果你的站点只有文档，或者你希望将文档放在根路径以优先显示它们呢？

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

docusaurus.config.js

export default {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          /* docs plugin options */
        },
        blog: {
          /* blog plugin options */
        },
        // ...
      },
    ],
  ],
};

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

docusaurus.config.js

export default {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          routeBasePath: '/', // Serve the docs at the site's root
          /* other docs plugin options */
        },
        blog: false, // Optional: disable the blog plugin
        // ...
      },
    ],
  ],
};

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

别忘了通过添加 Front Matter 将某个页面设为根路径（https://example.com/）的页面

docs/intro.md

---
slug: /
---

This page will be the home page when users visit https://example.com/.

警告

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

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

example.com/                       -> generated from `docs/intro.md`
example.com/tutorial-basics/...    -> generated from `docs/tutorial-basics/...`
...

提示

此外还有一个“纯博客模式”，适用于只想使用 Docusaurus 博客功能的用户。你可以使用上面详述的相同方法。请遵循纯博客模式的设置说明。