Skip to content

tacck/vuepress-plugin-sidebar

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

vuepress-plugin-sidebar

Sidebar-menu generator plugin for VuePress.

Instration

$ npm install --save-dev vuepress-plugin-sidebar
# or
$ yarn add --dev vuepress-plugin-sidebar

How to use

module.exports = {
  plugins: [
    ['sidebar']
  ]
}

Options

Add static links after generated menu

module.exports = {
  plugins: [
    [
      'sidebar', {
        postItems: [
          ['https://www.tacck.net/', 'Tacck.NET']
        ]
      }
    ]
  ]
}

Grouping menu

module.exports = {
  plugins: [
    [
      'sidebar', {
        grouping: true,
        groupOptions: {
          collapsable: true,
          sidebarDepth: 2,
        },
      }
    ]
  ]
}

If you want to set group title, please set frontmatter groupTitle on each directories' README.md.

---
groupTitle: Group Title 01
---

Please see example.

License

MIT License

About

Generate sidebar menu for VuePress

Resources

License

Stars

Watchers

Forks

Packages

No packages published