README.zh-CN.md

English | 简体中文

vitepress-auto-sidebar-plugin

根据文件结构自动生成侧边栏配置信息。

✨ 特性

• 🎨 易于使用，完全可配置，可以根据自己的需求量身定制

• 📑 多级侧边栏，可折叠，任你配置

• ✅ 文件隐藏可配置

• 🤖 支持文内 Frontmatter 配置

• 😃 自定义排序，Title 名称自定义映射

• 📦 内置文件名称下标排序

• 🦾 TypeScript 编写，强有力的保障

🚀 安装

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(),
    ],
  },
})

🌟 更多配置

更多配置可参考 vitepress-auto-sidebar-plugin 文档

😋最佳实践

可访问 Ares-Chang/notes 查看仓库最佳实践。

License

MIT License © 2023-PRESENT Ares Chang