Skip to content

docs: how to migrate from existing projects #658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Timeless0911 merged 1 commit into from
Jan 7, 2025
Merged

docs: how to migrate from existing projects #658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion website/docs/en/guide/start/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,20 @@ Options:
--override override files in target directory
```

## Migration
## Migrate from Existing Projects

If you need to migrate from an existing project to Rslib, you can refer to the following guides:

- [Migrating from tsup](/guide/migration/tsup)
- [Migrating from Modern.js Module](/guide/migration/modernjs-module)

### Other Projects

For other types of projects, you can manually install the [@rslib/core](https://www.npmjs.com/package/@rslib/core) package:

<PackageManagerTabs command="add @rslib/core -D" />

Then refer to the guide and documentation to enable the features you need:

- See [CLI](/guide/basic/cli) to learn about available CLI commands.
- See [Configure Rslib](/guide/basic/configure-rslib) to configure Rslib.
15 changes: 13 additions & 2 deletions website/docs/zh/guide/start/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ nvm install --lts
nvm use --lts
```

## 创建一个 Rslib 项目
## 创建 Rslib 项目

你可以使用 [`create-rslib`](https://www.npmjs.com/package/create-rslib) 创建一个 Rslib 项目。运行以下命令：

Expand Down Expand Up @@ -125,9 +125,20 @@ Options:
--override override files in target directory
```

## 迁移
## 从现有项目迁移

如果你需要从一个现有项目迁移迁移到 Rslib，可以参考以下指南：

- [从 tsup 迁移](/guide/migration/tsup)
- [从 Modern.js Module 迁移](/guide/migration/modernjs-module)

### 其他项目

对于其他类型的项目，你可以手动安装 [@rslib/core](https://www.npmjs.com/package/@rslib/core) 包：

<PackageManagerTabs command="add @rslib/core -D" />

然后参考指南和文档，按需启用各个功能：

- 参考 [命令行工具](/guide/basic/cli) 来了解可用的 CLI 命令。
- 参考 [配置 Rslib](/guide/basic/configure-rslib) 进行配置。
Loading