本页导航
article
自动生成侧边栏
AI摘要
本文介绍了vitepress-plugin-sidebar-depth插件,这是一个用于VitePress的插件,能够自动扫描项目目录中的Markdown文件来生成侧边栏。文章详细说明了插件的核心特性,包括支持自定义扫描深度、处理带序号的文件格式以及国际化支持。此外,还提供了插件的安装步骤、配置选项的详细参数说明,以及如何通过回调函数自定义侧边栏数据。该插件旨在简化VitePress项目的侧边栏配置流程。
vitepress-plugin-sidebar-depth使用
github地址
特性
- 🚀 扫描项目的目录,自动生成侧边栏数据,挂载到
themeConfig.sidebar - 🚀 支持自定义扫描的递归深度
- 🚀 支持
01.guide.md带有序号的文件格式,在渲染侧边栏数据时,带序号的文件位置比不带序号的文件高 - 🚀 支持 locales 国际化,挂载到
locales.[lang].themeConfig.sidebar
说明:在同层目录下,如果存在相同序号的文件时,后面的文件会覆盖前面的文件
侧边栏的 text 获取顺序:
- 如果为目录:按顺序从该目录下的
index.md, index.MD, 目录名.md文件获取一级标题,如果获取不到,则以目录名为text - 如果为文件:
formatter.title> Markdown 文件一级标题(titleFormMd为 true 生效) > Markdown 文件名
安装
安装 vitepress-plugin-sidebar-depth 插件
加载中...
最后更新于 2026-02-17 19:42