11# 快速上手
22
3- ## 初始化环境
3+ ## 环境准备
44
5- 开始之前,你需要先安装 [ Node.js] ( https://nodejs.org/ ) >= 16 版本,建议使用 Node.js LTS 版本。
5+ 开始之前,需要先安装 [ Node.js] ( https://nodejs.org/ ) >= 16 版本,推荐使用 Node.js LTS 版本。
66
7- 使用以下命令检查当前的 Node.js 版本:
7+ 通过以下命令检查当前的 Node.js 版本:
88
99``` bash
1010node -v
1111```
1212
13- 如果当前环境没有安装 Node.js,或者安装的版本太低,可以使用 [ nvm] ( https://github.com/nvm-sh/nvm ) 或 [ fnm] ( https://github.com/nvm-sh/nvm ) 或 [ fnm] ( https:///github.com/Schniz/fnm ) 进行安装 。
13+ 如果你的环境中尚未安装 Node.js,或是版本太低,可以通过 [ nvm] ( https://github.com/nvm-sh/nvm ) 或 [ fnm] ( https://github.com/nvm-sh/nvm ) 或 [ fnm] ( https:///github.com/Schniz/fnm ) 安装 。
1414
15- 以下是如何通过 nvm 安装的示例 :
15+ 下面是通过 nvm 安装的例子 :
1616
1717``` bash
1818# 安装 Node.js LTS
@@ -23,7 +23,7 @@ nvm use --lts
2323
2424## 创建一个 Rslib 项目
2525
26- 您可以使用 [ ` create-rslib ` ] ( https://www.npmjs.com/package/create-rslib ) 创建一个新的 Rslib 项目。运行以下命令:
26+ 你可以使用 [ ` create-rslib ` ] ( https://www.npmjs.com/package/create-rslib ) 创建一个 Rslib 项目。运行以下命令:
2727
2828import { PackageManagerTabs } from ' @theme' ;
2929
@@ -36,7 +36,7 @@ import { PackageManagerTabs } from '@theme';
3636 }}
3737/>
3838
39- 然后按照提示完成操作 。
39+ 然后按照提示操作即可 。
4040
4141### 模板
4242
@@ -56,9 +56,9 @@ import { PackageManagerTabs } from '@theme';
5656
5757### 开发工具
5858
59- ` create-rslib ` 可以帮助你设置一些常用的开发工具,包括 [ Vitest] ( https://vitest.dev/ ) 、[ Storybook] ( https://storybook.js.org/ ) 。您可以使用方向键和空格键进行选择。如果您不需要这些工具 ,只需按 Enter 跳过即可。
59+ ` create-rslib ` 可以帮助你设置一些常用的开发工具,包括 [ Vitest] ( https://vitest.dev/ ) 、[ Storybook] ( https://storybook.js.org/ ) 。你可以使用方向键和空格键进行选择。如果你不需要这些工具 ,只需按 Enter 跳过即可。
6060
61- - Vitest适用于所有模板 ,它将根据模板的选择进行调整。
61+ - Vitest 适用于所有模板 ,它将根据模板的选择进行调整。
6262- Storybook 可用于 Web 目标模板 (React),它将根据模板的选择进行调整。
6363
6464``` text
@@ -70,7 +70,7 @@ import { PackageManagerTabs } from '@theme';
7070
7171### 可选工具
7272
73- ` create-rslib ` 可以帮助您设置一些常用的格式化程序和 linter 工具,包括 [ Biome] ( https://biomejs.dev/ ) 、[ ESLint] ( https://eslint.org/ ) 和 [ prettier] ( https://prettier.io/ ) 。您可以使用箭头键和空格键进行选择。如果您不需要这些工具 ,只需按 Enter 跳过即可。
73+ ` create-rslib ` 可以帮助你设置一些常用的格式化程序和 linter 工具,包括 [ Biome] ( https://biomejs.dev/ ) 、[ ESLint] ( https://eslint.org/ ) 和 [ prettier] ( https://prettier.io/ ) 。你可以使用箭头键和空格键进行选择。如果你不需要这些工具 ,只需按 Enter 跳过即可。
7474
7575``` text
7676◆ Select additional tools (Use <space> to select, <enter> to continue)
@@ -81,12 +81,12 @@ import { PackageManagerTabs } from '@theme';
8181```
8282
8383:::tip
84- Biome 提供与 ESLint 和 Prettier 类似的 linting 和格式化功能。如果您选择 Biome,通常也不需要选择 ESLint 或 Prettier。
84+ Biome 提供与 ESLint 和 Prettier 类似的 linting 和格式化功能。如果你选择 Biome,通常也不需要选择 ESLint 或 Prettier。
8585:::
8686
8787### 当前目录
8888
89- 如果需要在当前目录下创建项目,可以将目标文件夹设置为 "." :
89+ 如果需要在当前目录下创建项目,可以将目标文件夹设置为 ` . ` :
9090
9191``` text
9292◆ Create Rslib Project
@@ -100,18 +100,18 @@ Biome 提供与 ESLint 和 Prettier 类似的 linting 和格式化功能。如
100100
101101### 快速生成
102102
103- [ create-rslib] ( https://www.npmjs.com/package/create-rslib ) 提供了一些 CLI 标志 。通过设置这些 CLI 标志,您可以跳过交互式选择步骤并使用一个命令创建项目 。
103+ [ create-rslib] ( https://www.npmjs.com/package/create-rslib ) 提供了一些 CLI 选项 。通过设置这些 CLI 选项,你可以跳过交互式选择步骤并使用一个命令创建项目 。
104104
105- 例如,要使用一个命令在 " my-project" 目录中创建一个示例项目 :
105+ 比如,一键创建 example 模版项目到 ` my-project ` :
106106
107107``` bash
108108npx create-rslib --dir my-project --template example
109109
110- # Using abbreviations
110+ # 使用缩写
111111npx create-rslib -d my-project -t example
112112```
113113
114- All the CLI flags of ` create-rslib ` :
114+ ` create-rslib ` 的完整的 CLI 选项如下:
115115
116116``` text
117117Usage: create-rslib [options]
@@ -127,7 +127,7 @@ Options:
127127
128128## 迁移
129129
130- 如果您需要从现有项目迁移到 Rslib ,可以参考以下指南:
130+ 如果你需要从一个现有项目迁移迁移到 Rsbuild ,可以参考以下指南:
131131
132132- [ 从 tsup 迁移] ( /guide/migration/tsup )
133133- [ 从 Modern.js Module 迁移] ( /guide/migration/modernjs-module )
0 commit comments