vitepress侧边栏生成工具
介绍
这是一个可以根据文件夹结构自动生成vitepress侧边栏的工具,你可以通过npm下载体验。
shell
npm i vitepressautosidebar
使用
在vitepress的config.mjs中引入该工具
js
import { vitepressAutoSidebar } from 'vitepressautosidebar'
export default {
// ...
themeConfig: {
// ...
sidebar: vitepressAutoSidebar(
// 这里是你的docs文件夹路径
path.resolve(__dirname, '../docs'),
// 这个是你的网站的根目录,你需要传入vitepress生成的网站的根目录来使得侧边栏的链接正确
path.resolve(__dirname, '../docs'),
[
// 这里是你需要忽略的文件夹和文件
'test',
'ls',
]
),
// 当然你也可以自己指定一些页面
sidebar: [
{
text: "关于本知识库",
link: "/README"
},
...vitepressAutoSidebar(
// ...
)
]
}
}
目前只支持在mjs文件中使用,并且还有一些小bug,我会在后续的版本中修复。