第8章 Docusaurus Docs 插件入门指南

版本：2.xDocs 文档简介 Docs 功能让用户能以层级结构组织 Markdown 文件。 info完整的配置项列表请查阅 Docs 插件 API 参考文档。 你网站的文档按四个层级组织，从低到高依次是： 单个页面 侧边栏 版本 插件实例 本指南将按此顺序介绍：先讲如何配置单个页面，再讲如何创建一个或多个侧边栏，然后是如何创建和管理版本，最后是如何使用多个 docs 插件实例。 仅文档模式 刚初始化的 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.jsmodule.exports = {
// ...
presets: [
'@docusaurus/preset-classic',
{
docs: {
/* docs 插件配置 */
},
blog: {
/* blog 插件配置 */
},
// ...
},
],
};
要进入仅文档模式，改成这样即可： docusaurus.config.jsmodule.exports = {
// ...
presets: [
'@docusaurus/preset-classic',
{
docs: {
routeBasePath: '/', // 文档挂载在站点根路径
/* 其他 docs 插件配置 */
},
blog: false, // 可选：禁用 blog 插件
// ...
},
],
};
注意，你不必因此放弃 blog 或其他插件；routeBasePath: '/' 做的只是让文档不再通过 https://example.com/docs/some-doc 访问，而是直接位于站点根路径 https://example.com/some-doc。如果 blog 启用了，依然可以通过 blog/ 子路由访问。 别忘了在根路径（https://example.com/）放一个页面，添加如下 front matter： 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 2 博客功能的用户，还有“仅博客模式”。您可以采用上述相同的方法，并遵循仅博客模式的设置说明。