English | 简体中文

Automatically generates the sidebar configuration based on the file structure

• 🎨 Easy to use, fully configurable and can be tailored to your needs

• 📑 Multi-level sidebar, collapsible, you can configure it

• ✅ File hiding can be configured

• 🤖 Support Frontmatter configuration

• 😃 Custom sorting, title name mapping can be customized

• 📦 Built-in file name index sorting

• 🦾 TypeScript, of course

pnpm add vitepress-auto-sidebar-plugin --save-dev

// .vitepress/config.ts
import { defineConfig } from 'vitepress'
import AutoSidebarPlugin from 'vitepress-auto-sidebar-plugin'

export default defineConfig({
  vite: {
    plugins: [
      AutoSidebarPlugin(),
    ],
  },
})

More configuration can be found in the vitepress-auto-sidebar-plugin documentation

You can view warehouse best practices at Ares-Chang/notes.

MIT License © 2023-PRESENT Ares Chang