Skip to content

docs: add version history tables to config files #6359

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
chenjiahan merged 2 commits into from
Oct 15, 2025
Merged

docs: add version history tables to config files #6359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bece565
docs: add version history tables to config files
chenjiahan Oct 14, 2025
6deb945
fix
chenjiahan Oct 14, 2025
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
7 changes: 6 additions & 1 deletion website/docs/en/config/dev/browser-logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

- **Type:** `boolean`
- **Default:** `true`
- **Version:** Added in v1.5.13

Controls whether to forward browser runtime errors to the terminal.

Expand Down Expand Up @@ -36,3 +35,9 @@ export default {
},
};
```

## Version history

| Version | Changes |
| ------- | ----------------- |
| v1.5.13 | Added this option |
2 changes: 1 addition & 1 deletion website/docs/en/config/dev/lazy-compilation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,5 +135,5 @@ Rsbuild will replace the `<port>` placeholder with the actual port number the se

| Version | Changes |
| ------- | --------------------------------------------------- |
| v1.3.0 | Added configuration option |
| v1.3.0 | Added this option |
| v1.5.0 | Changed default value from `false` to current value |
7 changes: 6 additions & 1 deletion website/docs/en/config/html/tags.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,6 @@ See [Injection position](#injection-position) for more details.

- **Type:** `Record<string, any>`
- **Default:** `undefined`
- **Version:** Added in v1.4.7

The metadata object for tags, used to store additional information about tags. `metadata` does not affect the generated HTML content.

Expand Down Expand Up @@ -486,3 +485,9 @@ The result will look like:
</script>
</body>
```

## Version history

| Version | Changes |
| ------- | ----------------------------------- |
| v1.4.7 | Added support for `metadata` option |
7 changes: 6 additions & 1 deletion website/docs/en/config/output/module.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

- **Type:** `boolean`
- **Default:** `false`
- **Version:** Added in v1.5.0

Whether to output JavaScript files in ES modules format.

Expand Down Expand Up @@ -49,3 +48,9 @@ export default {
},
};
```

## Version history

| Version | Changes |
| ------- | ----------------- |
| v1.5.0 | Added this option |
6 changes: 6 additions & 0 deletions website/docs/en/config/server/print-urls.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,3 +146,9 @@ Output:
```
➜ Local: http://localhost:3000
```

## Version history

| Version | Changes |
| ------- | -------------------------- |
| v1.5.17 | Support for custom `label` |
6 changes: 6 additions & 0 deletions website/docs/zh/config/dev/browser-logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@ export default {
},
};
```

## 版本历史

| 版本 | 变更内容 |
| ------ | ---------- |
| v1.3.0 | 新增该选项 |
2 changes: 1 addition & 1 deletion website/docs/zh/config/dev/lazy-compilation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,5 +135,5 @@ Rsbuild 会自动将 `<port>` 占位符替换为 server 实际监听的端口号

| 版本 | 变更内容 |
| ------ | --------------------------- |
| v1.3.0 | 新增配置项 |
| v1.3.0 | 新增该选项 |
| v1.5.0 | 默认值由 `false` 改为当前值 |
7 changes: 6 additions & 1 deletion website/docs/zh/config/html/tags.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,6 @@ export default {

- **类型：** `Record<string, any>`
- **默认值：** `undefined`
- **版本：** 添加于 v1.4.7

标签的元信息对象，用于存储标签的附加信息。`metadata` 不会影响生成的 HTML 内容。

Expand Down Expand Up @@ -486,3 +485,9 @@ export default {
</script>
</body>
```

## 版本历史

| 版本 | 变更内容 |
| ------ | -------------------- |
| v1.4.7 | 新增 `metadata` 选项 |
7 changes: 6 additions & 1 deletion website/docs/zh/config/output/module.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

- **类型：** `boolean`
- **默认值：** `false`
- **版本：** 添加于 v1.5.0

是否以 ES 模块格式输出 JavaScript 文件。

Expand Down Expand Up @@ -49,3 +48,9 @@ export default {
},
};
```

## 版本历史

| 版本 | 变更内容 |
| ------ | ---------- |
| v1.5.0 | 新增该选项 |
6 changes: 6 additions & 0 deletions website/docs/zh/config/server/print-urls.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,9 @@ export default {
```
➜ Local: http://localhost:3000
```

## 版本历史

| 版本 | 变更内容 |
| ------- | ------------------ |
| v1.5.17 | 支持自定义 `label` |
Loading