Skip to content

Commit fdf36de

Browse files
committed
chore: update
1 parent d9d43c3 commit fdf36de

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

skills/rspress-v2-upgrade/SKILL.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,21 @@ description: Migrate Rspress projects from v1 to v2. Use when a user asks to upg
1414

1515
2. **Open the official upgrade guide**
1616
- Use the v1 → v2 guide as the source of truth:
17-
- https://rspress.rs/zh/guide/migration/rspress-1-x
17+
- <https://rspress.rs/guide/migration/rspress-1-x>
1818

1919
3. **Plan the upgrade path**
2020
- List breaking changes that apply to the project's current config, plugins, and theme.
2121
- Note any removed or renamed packages, options, and APIs.
2222

2323
4. **Update dependencies**
2424
- Replace `rspress` with `@rspress/core@^2.0.0`.
25-
- Remove packages now built into `@rspress/core` (e.g. `rspress` `@rspress/plugin-shiki`, `@rspress/plugin-auto-nav-sidebar`, `@rspress/plugin-container-syntax`, `@rspress/plugin-last-updated`, `@rspress/plugin-medium-zoom`, `@rspress/theme-default`, `@rspress/runtime`).
25+
- Remove packages now built into `@rspress/core` (e.g. `rspress`, `@rspress/plugin-shiki`, `@rspress/plugin-auto-nav-sidebar`, `@rspress/plugin-container-syntax`, `@rspress/plugin-last-updated`, `@rspress/plugin-medium-zoom`, `@rspress/theme-default`, `@rspress/runtime`).
2626
- Bump remaining Rspress plugins to latest versions via `npx taze major --include /rspress/ -w -r`.
2727
- Ensure Node.js >= 20.9.0.
2828

2929
5. **Apply config and code changes**
3030
- Update import paths (`rspress/runtime``@rspress/core/runtime`, `rspress/theme``@rspress/core/theme`, `@rspress/theme-default``@rspress/core/theme-original`).
31+
- If the project has a custom theme (in `theme` directory), use `@rspress/core/theme-original` to import the original theme components.
3132
- Update the Rspress config to match v2 options and defaults.
3233
- Remove deprecated or unsupported settings.
3334

0 commit comments

Comments
 (0)