Vuepress Plugin Auto Sidebar
介绍(Introduction)
这是为 vuepress 自动生成侧边栏分组的插件。
1. 目录结构示例
docs
├── exampleMenu1
│ ├── exampleSubMenu1-1
│ │ └── file1.md
│ ├── exampleSubMenu1-2
│ │ └── exampleSubMenu1-2-1
| | └── file1.md
│ └── exampleSubMenu1-2
│ | ├── file1.md
│ | ├── file2.md
│ | └── file3.md
| ├── file1-1.md # 不推荐目录、文件同级
| └── README.md # 原因见 提问5
├── exampleMenu2
│ ├── file1.md
│ └── README.md
2. 在线示例
安装(Install)
npm i vuepress-plugin-auto-sidebar -D
使用(Usage)
1. 无注释
有部分使用者跟我说注释后显得太乱,那就简单点。
module.exports = {
plugins: {
"vuepress-plugin-auto-sidebar": {}
}
}
2. 注释
与上方一致,仅仅是添加了注释。
// 修改 docs/.vuepress/config.js
module.exports = {
// 引入插件
plugins: {
// 更多方式可参考:
// https://v1.vuepress.vuejs.org/zh/plugin/using-a-plugin.html
"vuepress-plugin-auto-sidebar": {} // 可参考下方的 “可选项”
},
themeConfig: {
// 无需配置