docs: add default theme sidebar changes to migration guide (close #1238…

…) (#1413) Co-authored-by: meteorlxy <[email protected]>
vuepress · Sep 29, 2023 · 386a3d9 · 386a3d9
1 parent 0b0108d
commit 386a3d9
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 0 deletions.
diff --git a/docs/guide/migration.md b/docs/guide/migration.md
@@ -275,6 +275,33 @@ Default theme config has been changed a lot. You'd better check the config refer
 
 See [Default Theme > Config](../reference/default-theme/config.md).
 
+Here we list some notable changes:
+
+##### Sidebar Config
+
+```diff
+- sidebar: {
+-   title: 'Foo Bar',
+-   path: '/foo/bar.html',
+-   collapsable: true,
+-   children: [
+-     ['/baz', 'Baz'],
+-   ],
+- }
+
++ sidebar: {
++   text: 'Foo Bar',
++   link: '/foo/bar.html',
++   collapsible: true,
++   children: [
++     {
++       text: 'Baz',
++       link: '/baz',
++     }
++   ],
++ }
+```
+
 ### Official Plugins Change
 
 Check the v2 docs of official plugins.

diff --git a/docs/zh/guide/migration.md b/docs/zh/guide/migration.md
@@ -275,6 +275,33 @@ Markdown 插槽不再被支持。
 
 参考 [默认主题 > 配置](../reference/default-theme/config.md) 。
 
+这里仅列出部分要注意的变更：
+
+##### 侧边栏配置
+
+```diff
+- sidebar: {
+-   title: 'Foo Bar',
+-   path: '/foo/bar.html',
+-   collapsable: true,
+-   children: [
+-     ['/baz', 'Baz'],
+-   ],
+- }
+
++ sidebar: {
++   text: 'Foo Bar',
++   link: '/foo/bar.html',
++   collapsible: true,
++   children: [
++     {
++       text: 'Baz',
++       link: '/baz',
++     }
++   ],
++ }
+```
+
 ### 官方插件变更
 
 查看 v2 版本的官方插件文档。