Skip to content

Commit ea8aca0

Browse files
authored
docs: link more content to Rspack website (#2155)
1 parent 48c85e4 commit ea8aca0

File tree

24 files changed

+25
-75
lines changed

24 files changed

+25
-75
lines changed

packages/core/src/client/hmr/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ function tryApplyUpdates() {
177177
}
178178
}
179179

180-
// https://webpack.js.org/concepts/hot-module-replacement
180+
// https://rspack.dev/api/modules#importmetawebpackhot-webpack-specific
181181
import.meta.webpackHot.check(true).then(
182182
(updatedModules) => {
183183
handleApplyUpdates(null, updatedModules);

packages/shared/src/types/config/dev.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export interface DevConfig {
5050
beforeStartUrl?: ArrayOrNot<() => Promise<void> | void>;
5151
/**
5252
* Set the URL prefix of static assets during development,
53-
* similar to the [output.publicPath](https://webpack.js.org/guides/public-path/) config of webpack.
53+
* similar to the [output.publicPath](https://rspack.dev/config/output#outputpublicpath) config of webpack.
5454
*/
5555
assetPrefix?: string | boolean;
5656
/**

packages/shared/src/types/config/output.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ export interface OutputConfig {
195195
targets?: RsbuildTarget[];
196196
/**
197197
* At build time, prevent some `import` dependencies from being packed into bundles in your code, and instead fetch them externally at runtime.
198-
* For more information, please see: [webpack Externals](https://webpack.js.org/configuration/externals/)
198+
* For more information, please see: [Rspack Externals](https://rspack.dev/config/externals)
199199
*/
200200
externals?: Externals;
201201
/**

packages/shared/src/types/config/source.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export type Decorators = {
2525
export interface SourceConfig {
2626
/**
2727
* Create aliases to import or require certain modules,
28-
* same as the [resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealias) config of webpack.
28+
* same as the [resolve.alias](https://rspack.dev/config/resolve) config of Rspack.
2929
*/
3030
alias?: ChainedConfigWithUtils<Alias, { target: RsbuildTarget }>;
3131
/**

website/docs/en/config/dev/asset-prefix.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ It's not recommended to set assetPrefix as a relative path, such as `'./assets/'
7878

7979
## Compare with `publicPath`
8080

81-
The functionality of `dev.assetPrefix` is basically the same as the [output.publicPath](https://rspack.dev/zh/config/output#outputpublicpath) config in Rspack.
81+
The functionality of `dev.assetPrefix` is basically the same as the [output.publicPath](https://rspack.dev/config/output#outputpublicpath) config in Rspack.
8282

8383
The differences from the native configuration are as follows:
8484

website/docs/en/config/output/asset-prefix.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ It's not recommended to set assetPrefix as a relative path, such as `'./assets/'
4343

4444
## Compare with `publicPath`
4545

46-
The functionality of `output.assetPrefix` is basically the same as the [output.publicPath](https://rspack.dev/zh/config/output#outputpublicpath) config in Rspack.
46+
The functionality of `output.assetPrefix` is basically the same as the [output.publicPath](https://rspack.dev/config/output#outputpublicpath) config in Rspack.
4747

4848
The differences from the native configuration are as follows:
4949

website/docs/en/config/output/externals.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
At build time, prevent some `import` dependencies from being packed into bundles in your code, and instead fetch them externally at runtime.
77

8-
For more information, please see: [webpack Externals](https://webpack.js.org/configuration/externals/)
8+
For more information, please see: [Rspack Externals](https://rspack.dev/config/externals)
99

1010
### Example
1111

website/docs/en/config/output/filename.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ When you import a module via dynamic import, the module will be bundled into a s
8484
const { add } = await import('./add.ts');
8585
```
8686

87-
If you want to specify a fixed name for the async module, you can use the [magic comments](https://webpack.js.org/api/module-methods/#magic-comments) provided by the bundler to achieve this, using `webpackChunkName ` to specify the module name:
87+
If you want to specify a fixed name for the async module, you can use the [magic comments](https://rspack.dev/api/modules#magic-comments) provided by the bundler to achieve this, using `webpackChunkName ` to specify the module name:
8888

8989
```js title="src/index.ts"
9090
const { add } = await import(

website/docs/en/guide/debug/debug-mode.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ For a complete introduction to Rsbuild config, please see the [Configure Rsbuild
5858

5959
## Rspack Config File
6060

61-
If the current project is built using Rspack, then in debug mode, Rsbuild will also automatically generate `dist/rspack.config.web.mjs` file, which contains the final generated Rspack config. In this file, you can see what is included in the config that Rsbuild finally passes to Rspack.
61+
Rsbuild will also automatically generate `dist/rspack.config.web.mjs` file, which contains the final generated Rspack config. In this file, you can see what is included in the config that Rsbuild finally passes to Rspack.
6262

6363
The structure of the file is as follows:
6464

@@ -78,28 +78,3 @@ export default {
7878
```
7979

8080
For a complete introduction to Rspack configs, please see [Rspack official documentation](https://rspack.dev/config/).
81-
82-
## Webpack Config File
83-
84-
If the current project is built using webpack, then in debug mode, Rsbuild will also automatically generate `dist/webpack.config.web.mjs` file, which contains the final generated webpack config. In this file, you can see what is included in the config that Rsbuild finally passes to webpack.
85-
86-
The structure of the file is as follows:
87-
88-
```js title="webpack.config.web.mjs"
89-
export default {
90-
resolve: {
91-
// some resolve configs...
92-
},
93-
module: {
94-
// some webpack loaders...
95-
},
96-
plugins: [
97-
// some webpack plugins...
98-
],
99-
// other configs...
100-
};
101-
```
102-
103-
In addition, if the project configures additional build targets, such as enabling the SSR capability of the framework (corresponding to additional Node.js build target), an additional `webpack.config.node.mjs` file will be generated in the `dist` directory, corresponding to the webpack config for SSR bundles.
104-
105-
For a complete introduction to webpack configs, please see [webpack official documentation](https://webpack.js.org/concepts/config/).

website/docs/en/guide/faq/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ export default {
8686
};
8787
```
8888

89-
For details, please refer to: [ignoreWarnings](https://webpack.js.org/configuration/other-options/#ignorewarnings).
89+
For details, please refer to: [ignoreWarnings](https://rspack.dev/config/other-options#ignorewarnings).

0 commit comments

Comments
 (0)