docs(theme-default): add config docs

vuepress · Jan 31, 2024 · 2d313f1 · 2d313f1
1 parent aa55e22
commit 2d313f1
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 14 deletions.
diff --git a/docs/themes/default/config.md b/docs/themes/default/config.md
@@ -202,6 +202,16 @@ export default {
   - [Default Theme > Config > logo](#logo)
   - [Default Theme > Config > colorMode](#colormode)
 
+### logoAlt
+
+- Type: `null | string`
+
+- Details:
+
+  Specify the alt text of the logo image.
+
+  If not specified, defaults to be the same as the site title.
+
 ### repo
 
 - Type: `string`
@@ -248,7 +258,7 @@ export default {
   If you want to set different sidebar for different sub paths, you can set this option to a _sidebar object_:
 
   - The key should be the path prefix.
-  - The value should be a _sidebar array_.
+  - The value should be a _sidebar array_ or set to `'heading'` to automatically generate the sidebar from the page headers for just the corresponding path.
 
 - Example 1:
 
@@ -294,12 +304,7 @@ export default {
           children: ['/guide/introduction.md', '/guide/getting-started.md'],
         },
       ],
-      '/reference/': [
-        {
-          text: 'Reference',
-          children: ['/reference/cli.md', '/reference/config.md'],
-        },
-      ],
+      '/reference/': 'heading',
     },
   }),
 }

diff --git a/docs/themes/default/locale.md b/docs/themes/default/locale.md
@@ -71,6 +71,22 @@ export default {
 }
 ```
 
+### navbarLabel
+
+- Type: `null | string`
+
+- Details:
+
+  `aria-label` value for main navigation in navbar.
+
+### pageNavbarLabel
+
+- Type: `null | string`
+
+- Details:
+
+  `aria-label` value for next/previous page navigation.
+
 ## editLinkText
 
 - Type: `string`

diff --git a/docs/zh/themes/default/config.md b/docs/zh/themes/default/config.md
@@ -202,6 +202,16 @@ export default {
   - [默认主题 > 配置 > logo](#logo)
   - [默认主题 > 配置 > colorMode](#colormode)
 
+### logoAlt
+
+- 类型：`null | string`
+
+- 详情：
+
+  指定 Logo 图片的替代文字。
+
+  当未指定时，将默认与站点标题相同。
+
 ### repo
 
 - 类型： `string`
@@ -248,7 +258,7 @@ export default {
   如果你想在不同子路径中使用不同的侧边栏，你可以将该配置项设置为 _侧边栏对象_ ：
 
   - Key 为路径前缀。
-  - Value 为 _侧边栏数组_ 。
+  - Value 为 _侧边栏数组_ 或 `"heading"` 以自动为相应路径生成基于标题的侧边栏。
 
 - 示例 1：
 
@@ -294,12 +304,7 @@ export default {
           children: ['/guide/introduction.md', '/guide/getting-started.md'],
         },
       ],
-      '/reference/': [
-        {
-          text: 'Reference',
-          children: ['/reference/cli.md', '/reference/config.md'],
-        },
-      ],
+      '/reference/': 'heading',
     },
   }),
 }

diff --git a/docs/zh/themes/default/locale.md b/docs/zh/themes/default/locale.md
@@ -71,6 +71,22 @@ export default {
 }
 ```
 
+### navbarLabel
+
+- 类型：`null | string`
+
+- 详情：
+
+  导航栏中主导航 `aria-label` 属性的值。
+
+### pageNavbarLabel
+
+- 类型：`null | string`
+
+- 详情：
+
+  下一页/上一页导航 `aria-label` 属性的值
+
 ## editLinkText
 
 - 类型： `string`