docs(gh): add removeEmptyGroup option

shanyuhai123 · Mar 29, 2022 · 5a11311 · 5a11311
1 parent e7ee494
commit 5a11311
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/packages/vuepress-docs-gh-pages/docs/features/plugin-options.md b/packages/vuepress-docs-gh-pages/docs/features/plugin-options.md
@@ -254,6 +254,20 @@ module.exports = {
 
 If you just ignore some file, you can use the [autoIgnore](/features/markdown-file-config.html#autoignore) in the markdown file.
 
+## removeEmptyGroup
+
+When you configure all files in a folder with [autoGroup](/features/markdown-file-config.html#multiple-groups), it will cause the default group to be empty, and when you want to hide it you can use:
+
+```js
+module.exports = {
+  plugins: [
+    "vuepress-plugin-auto-sidebar": {
+      removeEmptyGroup: true
+    }
+  ]
+}
+```
+
 ## nav
 
 This plugin also provides a way to generate nav.

diff --git a/packages/vuepress-docs-gh-pages/docs/zh/features/plugin-options.md b/packages/vuepress-docs-gh-pages/docs/zh/features/plugin-options.md
@@ -26,6 +26,7 @@ module.exports = {
         uncollapseList: []
       },
       ignore: [],
+      removeEmptyGroup: false,
       git: {
         trackStatus: 'all'
       }
@@ -257,6 +258,20 @@ module.exports = {
 
 如果你想隐藏单个文件，那么可在文件中添加 [autoIgnore](/zh/features/markdown-file-config.html#autoignore)。
 
+## removeEmptyGroup（隐藏空分组）
+
+当你将文件夹中所有文件都配置了 [autoGroup](/zh/features/markdown-file-config.html#多个分组) 时，会导致默认分组为空，想隐藏它时可使用：
+
+```js
+module.exports = {
+  plugins: [
+    "vuepress-plugin-auto-sidebar": {
+      removeEmptyGroup: true
+    }
+  ]
+}
+```
+
 ## nav（导航栏）
 
 为了简化你第一次搬迁博客、笔记的成本，它仅仅提供了一个简单的生成导航栏的方式。