Skip to content

shanyuhai123/vuepress-plugin-auto-sidebar

Folders and files

NameName
Last commit message
Last commit date
Mar 22, 2021
Mar 29, 2022
Mar 21, 2021
Mar 21, 2021
Dec 25, 2019
Nov 22, 2021
Mar 21, 2021
Mar 29, 2022
Jul 3, 2021
Mar 21, 2021
Jul 19, 2022

Repository files navigation

Vuepress Plugin Auto Sidebar

Vuepress Plugin Auto Sidebar npm npm

介绍(Introduction)

这是为 vuepress 自动生成侧边栏的插件。
This is a plugin that automatically generates a sidebar for vuepress.

安装(Install)

1. VuePress v1

npm i vuepress-plugin-auto-sidebar -D

2. VuePress v2

# vuepress v2 alpha(vuepress v2 仍处于测试阶段)
npm i vuepress-plugin-auto-sidebar@alpha -D

使用(Usage)

📖 更详细的文档见 vuepress-plugin-auto-sidebar
📖 For more detailed documentation, you can visit vuepress-plugin-auto-sidebar.

VuePress v1:

// 在 .vuepress/config.js 中配置插件
// edit .vuepress/config.js file
module.exports = {
  plugins: [
    ["vuepress-plugin-auto-sidebar", {}]
  ]
}

VuePress v2:

VuePress v2 不再支持插件修改 sidebar,所以你需要自行引入生成的 sidebar.js 文件。
VuePress v2 no longer supports plugins to modify sidebar, so you need to import the generated sidebar.js file yourself.

const sidebarConf = require('./sidebar')

module.exports = {
  plugins: [
    ["vuepress-plugin-auto-sidebar", {}]
  ],
  themeConfig: {
    sidebar: sidebarConf
  }
}

其他(Others)

1. Simple Navbar

我们扩展了 vuepress cli 来帮助你快速生成简单的导航栏,如何使用它
We have extended vuepress cli to help you quickly generate a simple navigation bar, how to use it.

# vuepress v2 不支持
# vuepress v2 not support
vuepress nav docs