自动目录插件

vite-plugin-vitepress-auto-sidebar

这是一个基于 VitePress 的 Vite 插件，它可以自动生成侧边栏数据，通过扫描目录。

• 

• 

• 

✨ 特性

🚀 自动创建侧边栏数据并注入到 config.ThemeConfig.sidebar

🤖 监听全局 *.md 文件以自动更新侧边栏数据当它们被添加或删除

🕯️ 使用方法

安装 vite-plugin-vitepress-auto-sidebar

# 推荐使用 pnpm 包管理器
pnpm i vite-plugin-vitepress-auto-sidebar
# 或者 yarn
yarn add vite-plugin-vitepress-auto-sidebar
# 或者 npm
npm install vite-plugin-vitepress-auto-sidebar

在 .vitepress/config.ts 中添加插件

import AutoSidebar from 'vite-plugin-vitepress-auto-sidebar'

export default defineConfig({
  vite: {
    plugins: [
      // 添加插件
      AutoSidebar({
        // 你可以设置选项来调整侧边栏数据
        // 见选项文档下方
      })
    ]
  }
})

警告：你必须在 config.ts 中清除侧边栏对象，否则可能无法正常工作

pnpm run dev

 [auto-sidebar] 注入侧边栏数据成功

如果看到上述消息，说明插件正在正常工作，否则可能存在问题

🛠️ 选项

name	description	type	default
ignoreList	忽略指定文件夹	string[]	true
path	创建扫描路径以生成侧边栏	string	/docs
ignoreIndexItem	忽略只有 index.md 的页面侧边栏	boolean	false
collapsed	通过为侧边栏组添加 collapsed 选项，它显示一个切换按钮以隐藏/显示每个部分，For 具体使用方法，请参考 VitePress	boolean	false
deletePrefix	删除 md 文件前缀	string
sideBarResolved	接收完整的侧边栏对象，用于自定义修改	(data: DefaultTheme.SidebarMulti) => DefaultTheme.SidebarMulti
sideBarItemsResolved	接收完整的侧边栏子项对象，用于自定义修改	(data: DefaultTheme.SidebarItem[]) => DefaultTheme.SidebarItem[]
beforeCreateSideBarItems	获取在生成侧边栏子项之前扫描的文件名列表。如果你想要对侧边栏数据进行排序，建议使用此方法	(data: string[]) => string[]
titleFromFile	从 md 文件中读取标题	`