npm.io
0.0.8 • Published 3 years ago

@vitepress-custom/vitepress-plugin-sidebar

Licence
MIT
Version
0.0.8
Deps
0
Size
5 kB
Vulns
0
Weekly
0
DeprecatedThis package is deprecated

vitepress-plugin-sidebar

Brief

Automatic generate the navigation bar based on the file directory

Dependence

Need dependence on vitepress-plugin-fetch-docs library. vitepress-plugin-fetch-docs used to get all documents.

Usage

npm install vitepress-plugin-fetch-docs vitepress-plugin-sidebar
// docs/.vitepress/config.js
import docsData from 'vitepress-plugin-fetch-docs' // return promise
import sidebar from 'vitepress-plugin-sidebar'
async ()=>{
  let docs = await docsData()
  themeConfig:{
    // Pass docs as parameter to the nav method
    sidebar: sidebar(docs)
  }
}

Keywords