chore: optimize theme doc

sanyuan0704 · Oct 7, 2022 · fbb4ed5 · fbb4ed5 · vercel · Oct 7, 2022
1 parent d16a79e
commit fbb4ed5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/docs/en/api/config-theme.md b/docs/en/api/config-theme.md
@@ -52,11 +52,13 @@ export default defineConfig({
 
 ## sidebar
 
-- Type: `Array` | `Object`
+- Type: `Object`
 
-The sidebar of the site.The config is a map for `SidebarGroup`, which has following type:
+The sidebar of the site.The config is a object, which
 
 ```ts
+// The key is the path of the sidebar group
+// The value is the sidebar group
 type Sidebar = Record<string, SidebarGroup[]>;
 
 interface SidebarGroup {

diff --git a/docs/zh/api/config-theme.md b/docs/zh/api/config-theme.md
@@ -52,11 +52,13 @@ export default defineConfig({
 
 ## sidebar
 
-- Type: `Array` | `Object`
+- Type: `Object`
 
-网站的侧边栏。配置是 `SidebarGroup` 的映射类型，具有以下类型：
+网站的侧边栏。配置为一个对象，类型如下：
 
 ```ts
+// key 为 SidebarGroup 的路径
+// value 为 SidebarGroup
 type Sidebar = Record<string, SidebarGroup[]>;
 
 interface SidebarGroup {