VitePress Sidebar
库工具
根据磁盘上的文件生成 VitePress 侧边栏的插件。排序、标题、过滤和按文件夹的设置,取代了手工维护的菜单。
关于这个项目
VitePress Sidebar 依据目录结构生成 VitePress 站点的侧边栏,这样文档站点就不必再带着一份手写的菜单——每加一页、每改一个名字、每挪动一次都得跟着改。它用一次函数调用包住 VitePress 的配置,其余一切照旧。
生成的菜单是可调的,而不是定死的。标题可以取自文件标题或前置数据;目录可以排序、按指定层级折叠、过滤、改名或排除;某个需要与众不同的目录还能带上自己的配置文件。多侧边栏和前置数据覆盖都按 VitePress 文档所写的方式工作,默认主题原本能做的事一样不少。
它以 TypeScript 编写并自带类型定义,只给构建增加很少的开销、给页面不增加任何东西,并跟随当前的 VitePress 版本。每一个选项都有带示例的文档。
功能
文档站点
TypeScript 类型
多语言支持
经测试验证
