Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ares-chang/vitepress-auto-sidebar-plugin
Automatically generates the sidebar configuration based on the file structure
https://github.com/ares-chang/vitepress-auto-sidebar-plugin
vitepress vitepress-auto-sidebar vitepress-plugin
Last synced: 14 days ago
JSON representation
Automatically generates the sidebar configuration based on the file structure
- Host: GitHub
- URL: https://github.com/ares-chang/vitepress-auto-sidebar-plugin
- Owner: Ares-Chang
- License: mit
- Created: 2024-03-15T06:08:26.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-04-28T03:35:18.000Z (8 months ago)
- Last Synced: 2024-11-24T19:36:42.137Z (about 1 month ago)
- Topics: vitepress, vitepress-auto-sidebar, vitepress-plugin
- Language: TypeScript
- Homepage: https://vitepress-auto-sidebar-plugin.netlify.app
- Size: 328 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
English | 简体中文
# vitepress-auto-sidebar-plugin
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]
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
```bash
pnpm add vitepress-auto-sidebar-plugin --save-dev
```
## ⚡️ Usage
```ts
// .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](https://vitepress-auto-sidebar-plugin.netlify.app/) documentation
## 😋 Best practices
You can view warehouse best practices at [Ares-Chang/notes](https://github.com/Ares-Chang/notes).
## License
[MIT](./LICENSE) License © 2023-PRESENT [Ares Chang](https://github.com/Ares-Chang)
[npm-version-src]: https://img.shields.io/npm/v/vitepress-auto-sidebar-plugin?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/vitepress-auto-sidebar-plugin
[npm-downloads-src]: https://img.shields.io/npm/dm/vitepress-auto-sidebar-plugin?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/vitepress-auto-sidebar-plugin
[bundle-src]: https://img.shields.io/bundlephobia/minzip/vitepress-auto-sidebar-plugin?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=vitepress-auto-sidebar-plugin
[license-src]: https://img.shields.io/github/license/Ares-Chang/vitepress-auto-sidebar-plugin.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/Ares-Chang/vitepress-auto-sidebar-plugin/blob/master/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/vitepress-auto-sidebar-plugin