⚡
VitePress Plugin: Auto Sidebar
Generate the VitePress sidebar through the folder structure.
Features
- Small library
- TypeScript Support
Setup
yarn add vitepress-plugin-auto-sidebar # yarn
npm i vitepress-plugin-auto-sidebar # npm
Basic usage
.vitepress/config.js
import { getSidebar } from 'vitepress-plugin-auto-sidebar'
export default {
themeConfig: {
sidebar: getSidebar({ contentRoot: '/', contentDirs: ['team'], collapsible: true, collapsed: true })
}
}
Options
- contentRoot – Default: '/'
String Root of your VitePress Docs
- contentDirs – Default: null
Array of indexable contentRoot dirs, if you want to include seperatly - null mean all dirs in the contentRoot are indexed
- collapsible – Default: true
Boolean whether the first level can be unfolded
- collapsed – Default: true
Boolean whether the first level items are already expanded after loading
License
Copyright (c) 2022 Jonathan Schneider MIT License
7 Oct 8, 2022
10 Dec 1, 2022
19 Dec 19, 2022
3 Mar 12, 2022
17 Nov 24, 2022
26 Dec 26, 2022
38 Mar 18, 2022
11 Sep 7, 2022
14 Jun 13, 2022
11 Dec 20, 2022