文档介绍

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

info

查看 文档插件 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/.

warning

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

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

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

tip

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