Giter VIP home page Giter VIP logo

vitepress-plugin-auto-sidebar's Introduction

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: 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

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

License

Copyright (c) 2022 Jonathan Schneider MIT License

vitepress-plugin-auto-sidebar's People

Contributors

jonathanschndr avatar zhongxuyang avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.