进阶 docusaurus.io 2026-10-13 10:58:59 · 20 阅读
第16章 Docusaurus 侧边栏详解:分组、导航与配置
版本:2.x 侧边栏
创建侧边栏可以帮你:
- 将多个相关文档分组
- 在每个文档页面上展示侧边栏
- 提供带上一页/下一页按钮的分页导航
要在 Docusaurus 网站中使用侧边栏:
- 定义一个导出侧边栏对象字典的文件
- 将该对象直接传给 @docusaurus/plugin-docs 插件,或通过 @docusaurus/preset-classic 传入
docusaurus.config.js
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
},
},
],
],
};
本节概述了文档侧边栏的一些零散功能。接下来的章节会更系统地介绍以下概念: 📄️ 侧边栏项(Sidebar items) 上一节的示例中我们已经介绍了三种条目类型,其中 autogenerated(自动生成)将在后面详细讲解。
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
},
},
],
],
};
本节概述了文档侧边栏的一些零散功能。接下来的章节会更系统地介绍以下概念: 📄️ 侧边栏项(Sidebar items) 上一节的示例中我们已经介绍了三种条目类型,其中 autogenerated(自动生成)将在后面详细讲解。