Nice Pottery Mug

    vuepress-plugin-sidebar

    0.2.1 • Public • Published

    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

    Install

    npm i vuepress-plugin-sidebar

    DownloadsWeekly Downloads

    0

    Version

    0.2.1

    License

    MIT

    Unpacked Size

    5.74 kB

    Total Files

    5

    Last publish

    Collaborators

    • tacck