Skip to content

Commit

Permalink
Add Sidebar changes to migration Docs
Browse files Browse the repository at this point in the history
Per Issue vuepress#1238 added some highlights for theme changes related to sidebars that we had to dig for in theme config.
  • Loading branch information
fdevans authored Sep 28, 2023
1 parent 0b0108d commit 4f9026f
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/guide/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,35 @@ Default theme config has been changed a lot. You'd better check the config refer

See [Default Theme > Config](../reference/default-theme/config.md).

##### Some theme notable changes:

Sidebar children no longer support arrays in arrays.

Old V1
```js
{
title: 'Configuring Atlantis',
path: '/your/path'
collapsible: true,
children: [
['configuring-atlantis', 'Overview'],
```
New V2 format
```js
{
text: 'Configuring Atlantis',
link: '/your/path'
collapsible: true,
children: [
{
text: 'Overview',
link: 'configuring-atlantis',
},
```
> Note the change in some of the keys used also: `title -> text` and `path -> link`
### Official Plugins Change
Check the v2 docs of official plugins.
Expand Down

0 comments on commit 4f9026f

Please sign in to comment.