Skip to content

Commit

Permalink
chore(doc): update rspress version to adapt rspack builtin:swc-loader (
Browse files Browse the repository at this point in the history
  • Loading branch information
9aoy authored Sep 27, 2023
1 parent a94260d commit baed8bf
Show file tree
Hide file tree
Showing 9 changed files with 62 additions and 50 deletions.
8 changes: 8 additions & 0 deletions .changeset/new-donkeys-hide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
'@modern-js/builder-doc': patch
'@modern-js/module-tools-docs': patch
---

chore(doc): update rspress version to adapt rspack builtin:swc-loader

chore(doc): 更新 rspress 版本来适配 rspack builtin:swc-loader
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@
"pnpm": {
"overrides": {
"@types/react": "^18",
"@types/react-dom": "^18"
"@types/react-dom": "^18",
"rspress": "0.0.0-next-20230927072732",
"@rspress/shared": "0.0.0-next-20230927072732"
},
"allowedDeprecatedVersions": {
"@babel/plugin-proposal-class-properties": "7.18.6",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Builder Configs are divided into the following categories:
- [Security Config](/api/config-security.html): Config related to security.
- [Performance Config](/api/config-performance.html): Config related to performance.

You can find detailed descriptions of all configs on the [API Reference](/en/api/) page.
You can find detailed descriptions of all configs on the [API Reference](/en/api/index) page.

## Default Values

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ if you want to use webpack instead of Rspack, you can replace the `@modern-js/bu

There are two steps to creating a Builder instance:

First you need to initialize the Builder Provider and pass in the `builderConfig` config object. Builder provides a lot of configs that allow you to customize the build behavior. At this point, you don't need to know the specific content of the config, just pass in an empty object. You can find all available configs in [API - config](/en/api/#config).
First you need to initialize the Builder Provider and pass in the `builderConfig` config object. Builder provides a lot of configs that allow you to customize the build behavior. At this point, you don't need to know the specific content of the config, just pass in an empty object. You can find all available configs in [API - config](/en/api/index#config).

- Initialize the Rspack Provider:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Builder 中的配置可以分为以下几类:
- [Security Config](/api/config-security.html):与安全有关的配置。
- [Performance Config](/api/config-performance.html):与编译性能、产物性能有关的配置。

你可以在 [API Reference](/api/) 页面找到所有配置项的详细说明。
你可以在 [API Reference](/api/index) 页面找到所有配置项的详细说明。

## 配置默认值

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ import { PackageManagerTabs } from '@theme';

创建 Builder 实例的过程分两步:

首先你需要初始化 Builder Provider,并传入 `builderConfig` 配置对象。Builder 提供了丰富的配置项,允许你对构建行为进行灵活定制。此时你还不需要了解配置项的具体内容,传入一个空对象即可。你可以在 [API - 配置](/api/#配置) 中找到所有可用的配置项。
首先你需要初始化 Builder Provider,并传入 `builderConfig` 配置对象。Builder 提供了丰富的配置项,允许你对构建行为进行灵活定制。此时你还不需要了解配置项的具体内容,传入一个空对象即可。你可以在 [API - 配置](/api/index#配置) 中找到所有可用的配置项。

- 初始化 webpack Provider:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export interface BuildCommandOptions {
type Return = BuildConfig;
```

> `BuildConfig` type reference [API configuration](en/api/)
> `BuildConfig` type reference [API configuration](en/api/index)
### `beforeBuildTask`

Expand All @@ -74,7 +74,7 @@ export const myPlugin = (): CliPlugin<ModuleTools> => ({

Parameters and return value types.

`BaseBuildConfig` type reference [API configuration](en/api/)
`BaseBuildConfig` type reference [API configuration](en/api/index)

### `afterBuildTask`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export interface BuildCommandOptions {
type Return = BuildConfig;
```

> `BuildConfig` 类型参考 [API 配置](/api/)
> `BuildConfig` 类型参考 [API 配置](/api/index)
### `beforeBuildTask`

Expand All @@ -76,7 +76,7 @@ export const myPlugin = (): CliPlugin<ModuleTools> => ({

参数和返回值类型:

`BaseBuildConfig` 类型参考 [API 配置](/api/)
`BaseBuildConfig` 类型参考 [API 配置](/api/index)

### `afterBuildTask`

Expand Down
84 changes: 43 additions & 41 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit baed8bf

Please sign in to comment.