Skip to content

Commit 6e53be6

Browse files
committed
docs: add more to migration from vitepress 0.x
1 parent 08fe348 commit 6e53be6

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

docs/guide/migration-from-vitepress-0.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,22 @@
22

33
If you're coming from VitePress 0.x version, there're several breaking changes due to new features and enhancement. Please follow this guide to see how to migrate your app over to the latest VitePress.
44

5-
## Config: Frontmatter
5+
## App Config
66

7-
- `home: true` option has changed to `layout: home`. Also, many Homepage related settings have been modified to provide additional features. See [Homepage guide](../guide/theme-homepage) for details.
7+
- The internationalization feature is not yet implemented.
8+
9+
## Theme Config
10+
11+
- `sidebar` option has changed its structure.
12+
- `children` key is now named `items`.
13+
- Top level item may not contain `link` at the moment. We're planning to bring it back.
14+
- `repo`, `repoLabel`, `docsDir`, `docsBranch`, `editLinks`, `editLinkText` are removed in favor of more flexible api.
15+
- For adding GitHub link with icon to the nav, use [Social Links](./theme-nav.html#navigation-links) feature.
16+
- For adding "Edit this page" feature, use [Edit Link](./theme-edit-link) feature.
17+
- `lastUpdated` option is now split into `config.lastUpdated` and `themeConfig.lastUpdatedText`.
18+
- `carbonAds.carbon` is changed to `carbonAds.code`.
19+
20+
## Frontmatter Config
21+
22+
- `home: true` option has changed to `layout: home`. Also, many Homepage related settings have been modified to provide additional features. See [Homepage guide](./theme-homepage) for details.
823
- `footer` option is moved to [`themeConfig.footer`](../config/theme-configs#footer).

0 commit comments

Comments
 (0)