Rspress 插件：基于顶部导航栏 (navbar) 配置自动生成侧边栏 (sidebar)。
npm install rspress-plugin-auto-sidebar
# 或者
yarn add rspress-plugin-auto-sidebar
# 或者
pnpm add rspress-plugin-auto-sidebar在 rspress.config.ts 中引入本插件。只需在 navbar 的某一项中添加自定义属性 scanDir，插件就会自动扫描该目录下的 Markdown/MDX 文件，并自动生成侧边栏。
import { defineConfig } from 'rspress/config';
import { pluginAutoSidebar } from 'rspress-plugin-auto-sidebar';
export default defineConfig({
plugins: [
pluginAutoSidebar({
reverse: true, // 可选：全局默认按 sort 降序
navbar: [
{
text: '指南',
link: '/guide/',
scanDir: '/guide/', // 扫描 docs/guide 目录生成侧边栏
},
{
text: 'API',
link: '/api/',
scanDir: '/api/', // 扫描 docs/api 目录生成侧边栏
}
],
// 可选：如果你的文档根目录不是 docs，可配置 docsDir
// docsDir: 'docs'
}),
],
});注意：如果通过插件选项传入 navbar，它会自动覆盖到 themeConfig.nav 中，你就不需要再在 themeConfig 里额外写一遍导航配置。
如果你不想把导航栏配置传给插件，也可以向平常一样直接在 themeConfig.nav 中配置，只要加上 scanDir 属性即可。
import { defineConfig } from 'rspress/config';
import { pluginAutoSidebar } from 'rspress-plugin-auto-sidebar';
export default defineConfig({
themeConfig: {
nav: [
{
text: '指南',
link: '/guide/',
scanDir: '/guide/',
reverse: true, // 可选：当前导航项覆盖全局排序方向
}
],
},
plugins: [
pluginAutoSidebar(), // 无需传参
],
});- 自动生成侧边栏：自动读取
scanDir对应路径（如docs/guide）下的所有文档文件，生成text和link的平铺侧边栏列表项目。不会添加多余的一层嵌套父级。 - 支持 Overview 排序：自动解析 Markdown Frontmatter，如果该文件内包含
overview: true，会被优先排在页面的最上方。 - 提取 Title：如果文件包含
title: xxx的 Frontmatter，会自动用作侧边栏的文本展示名称，否则自动退化使用文件名。 - 支持 Sort 排序：如果文件包含
sort: number的 Frontmatter，会按照数字大小排序，数值越小越靠前。有sort字段的文件会排在没有sort字段的文件前面。 - 支持反向 Sort 排序：可通过
pluginAutoSidebar({ reverse: true })设置全局默认降序，也可在单个scanDir导航项上通过reverse: true覆盖全局配置。启用后会按sort降序排列，sort未定义的页面仍排在最后。
export interface AutoSidebarNavItem {
text: string;
link?: string;
items?: AutoSidebarNavItem[];
children?: AutoSidebarNavItem[];
scanDir?: string;
reverse?: boolean;
}
export interface AutoSidebarOptions {
navbar?: AutoSidebarNavItem[];
docsDir?: string;
reverse?: boolean;
}