Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 1.97 KB

README.md

File metadata and controls

66 lines (47 loc) · 1.97 KB

VitePress Plugin: Auto Sidebar

⚡ VitePress Plugin: Auto Sidebar

npm version npm downloads License

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: ['/']

    Array of indexable contentRoot dirs, if you want to include separately. Accepts string[] or { path: string, title?: string }[]

  • 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

  • useFrontmatter - Default: false

    Boolean whether use front-matter for title of items

Tips: If you want to ignore a file, name the .md file with an underscore (_).

License

Copyright (c) 2022 Jonathan Schneider MIT License