vitepress-auto-sidebar-plugin
TypeScript icon, indicating that this package has built-in type declarations

0.2.4 • Public • Published

Uni Vitesse - Opinionated Vite Starter Template

English | 简体中文

vitepress-auto-sidebar-plugin

npm version npm downloads bundle JSDocs License

Automatically generates the sidebar configuration based on the file structure

✨ Feature

  • 🎨 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

🚀 Install

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

⚡️ Usage

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

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

🌟 More Configuration

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

License

MIT License © 2023-PRESENT Ares Chang

Package Sidebar

Install

npm i vitepress-auto-sidebar-plugin

Weekly Downloads

23

Version

0.2.4

License

MIT

Unpacked Size

34.4 kB

Total Files

9

Last publish

Collaborators

  • areschang