文档
该文档创建于2024-09-03，最后更新于2024-09-03。
文档
文档简介
文档功能为用户提供了一种以分层格式组织 Markdown 文件的方法。
信息
信息
检查 文档插件 API 参考文档 以获得详尽的选项列表。
你站点的文档按四个级别进行组织，从最低到最高：
- 单独的页面。
- 侧边栏。
- 版本。
- 插件实例。
指南将按以下顺序介绍它们：从 如何配置各个页面 开始，到 如何创建一个或多个侧边栏，到 如何创建和管理版本，到 如何使用多个文档插件实例。
仅文档模式
刚刚初始化的 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/ 子路由访问。
不要忘记通过添加前面的内容将某些页面放在根目录（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 博客功能的人来说，还有 "仅博客模式"。你可以使用上面详述的相同方法。按照 纯博客模式 上的设置说明进行操作。