Skip to content

Commit 144b78e

Browse files
Timeless0911Timeless0911
committed
docs: refactor section headers
1 parent 3ee894b commit 144b78e

File tree

20 files changed

+146
-166
lines changed

20 files changed

+146
-166
lines changed

‎website/docs/en/config/_meta.json‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
[
22
{
3-
"type": "file",
4-
"name": "index",
5-
"label": "Config Overview"
3+
"type": "section-header",
4+
"label": "Overview"
65
},
6+
"index",
77
{
8-
"type": "dir",
8+
"type": "dir-section-header",
99
"name": "lib",
10-
"label": "Lib Configurations"
10+
"label": "Lib configurations"
1111
},
1212
{
13-
"type": "dir",
13+
"type": "dir-section-header",
1414
"name": "rsbuild",
15-
"label": "Rsbuild Configurations"
15+
"label": "Rsbuild configurations"
1616
}
1717
]

‎website/docs/en/config/index.mdx‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
2-
overview: true
3-
title: Config Overview
2+
title: Config overview
43
---
54

65
This page lists all the configurations for Rslib. See [Configure Rslib](/guide/basic/configure-rslib) for detail.
6+
7+
import Overview from '@components/Overview';
8+
9+
<Overview />

‎website/docs/en/config/lib/_meta.json‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
[
2-
"format",
3-
"bundle",
2+
"index",
43
"auto-extension",
54
"auto-external",
6-
"redirect",
7-
"syntax",
8-
"external-helpers",
95
"banner",
10-
"footer",
6+
"bundle",
117
"dts",
12-
"shims",
8+
"experiments",
9+
"external-helpers",
10+
"format",
1311
"id",
14-
"umd-name",
1512
"out-base",
16-
"experiments"
13+
"footer",
14+
"redirect",
15+
"shims",
16+
"syntax",
17+
"umd-name"
1718
]

‎website/docs/en/config/lib/index.mdx‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1-
# Lib configurations
1+
# Overview
22

33
- **Type:**
44

55
```ts
66
interface LibConfig extends EnvironmentConfig {
7-
format?: Format;
8-
bundle?: boolean;
97
autoExtension?: boolean;
108
autoExternal?: AutoExternal;
11-
redirect?: Redirect;
12-
syntax?: Syntax;
13-
externalHelpers?: boolean;
149
banner?: BannerAndFooter;
10+
bundle?: boolean;
11+
dts?: Dts;
12+
experiments?: { advancedEsm?: boolean };
13+
externalHelpers?: boolean;
14+
format?: Format;
15+
id?: string;
16+
outBase?: string;
1517
footer?: BannerAndFooter;
18+
redirect?: Redirect;
1619
shims?: Shims;
17-
dts?: Dts;
20+
syntax?: Syntax;
1821
umdName?: Rspack.LibraryName;
1922
}
2023

‎website/docs/en/config/rsbuild/_meta.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[
2+
"index",
23
{
34
"type": "file",
45
"name": "log-level",

‎website/docs/en/config/rsbuild/index.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
import { RsbuildDocBadge } from '@components/RsbuildDocBadge';
22

3-
# Rsbuild configurations
3+
# Overview
44

55
Rslib inherits its configuration from Rsbuild, so you can also configure the <RsbuildDocBadge path="/config" text="config" /> options from Rsbuild. This chapter introduces some common configuration items and explains how to use them in Rslib.
66

7-
:::tip
8-
To learn more about Rslib configurations, check out [Configure Rslib](/guide/basic/configure-rslib).
9-
:::
10-
117
## Overview
128

139
- [logLevel](/config/rsbuild/log-level): Specify the log level.
@@ -17,3 +13,7 @@ To learn more about Rslib configurations, check out [Configure Rslib](/guide/bas
1713
- [tools](/config/rsbuild/tools): Options for low-level tools.
1814
- [performance](/config/rsbuild/performance): Options for performance.
1915
- [plugins](/config/rsbuild/plugins): Configure Rsbuild plugins.
16+
17+
:::tip
18+
To learn more about Rslib configurations, check out [Configure Rslib](/guide/basic/configure-rslib).
19+
:::

‎website/docs/en/guide/_meta.json‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
[
22
{
3-
"type": "dir",
3+
"type": "dir-section-header",
44
"name": "start",
5-
"label": "Getting Started"
5+
"label": "Start"
66
},
77
{
8-
"type": "dir",
8+
"type": "dir-section-header",
99
"name": "solution",
1010
"label": "Solution"
1111
},
1212
{
13-
"type": "dir",
13+
"type": "dir-section-header",
1414
"name": "basic",
1515
"label": "Basic"
1616
},
1717
{
18-
"type": "dir",
18+
"type": "dir-section-header",
1919
"name": "advanced",
2020
"label": "Advanced"
2121
},
2222
{
23-
"type": "dir",
23+
"type": "dir-section-header",
2424
"name": "migration",
2525
"label": "Migration"
2626
},
2727
{
28-
"type": "dir",
28+
"type": "dir-section-header",
2929
"name": "faq",
3030
"label": "FAQ"
3131
}

‎website/docs/en/guide/solution/_meta.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
["nodejs", "react", "vue"]
1+
["index", "nodejs", "react", "vue"]

‎website/docs/en/guide/solution/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Solution
1+
# Overview
22

33
In this chapter, we will introduce how to use Rslib to development libraries for browser and Node.js. We will also cover how to create libraries for different UI frameworks.
44

‎website/docs/zh/config/_meta.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[
22
{
3-
"type": "file",
4-
"name": "index",
5-
"label": "配置总览"
3+
"type": "section-header",
4+
"label": "总览"
65
},
6+
"index",
77
{
8-
"type": "dir",
8+
"type": "dir-section-header",
99
"name": "lib",
1010
"label": "Lib 配置"
1111
},
1212
{
13-
"type": "dir",
13+
"type": "dir-section-header",
1414
"name": "rsbuild",
1515
"label": "Rsbuild 配置"
1616
}

0 commit comments

Comments
 (0)