Skip to content

docs: update section headers #6597

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 3 commits into from
Nov 17, 2025
Merged

docs: update section headers #6597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
faf50e7
docs: update section headers
chenjiahan Nov 17, 2025
9d22b0f
docs
chenjiahan Nov 17, 2025
bb84fec
fix
chenjiahan Nov 17, 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
10 changes: 5 additions & 5 deletions pnpm-lock.yaml
View file
Open in desktop

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

6 changes: 3 additions & 3 deletions website/docs/en/api/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[
{
"type": "dir",
"type": "dir-section-header",
"name": "start",
"label": "Start"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "javascript-api",
"label": "JavaScript API"
"label": "APIs"
}
]
6 changes: 5 additions & 1 deletion website/docs/en/community/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
[
{
"type": "section-header",
"label": "Community"
},
"index",
{
"type": "dir",
"type": "dir-section-header",
"name": "releases",
"label": "Releases"
}
Expand Down
2 changes: 1 addition & 1 deletion website/docs/en/community/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Community
# Rsbuild community

## Version

Expand Down
50 changes: 29 additions & 21 deletions website/docs/en/config/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,62 +1,70 @@
[
{
"type": "section-header",
"label": "Overview"
},
{
"type": "file",
"name": "index",
"label": "Overview"
"label": "Config overview"
},
{
"type": "section-header",
"label": "Base options"
},
"root",
"mode",
"plugins",
"log-level",
"environments",
{
"type": "dir",
"type": "dir-section-header",
"name": "dev",
"label": "dev"
"label": "Dev options"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "resolve",
"label": "resolve"
"label": "Resolve options"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "source",
"label": "source"
"label": "Source options"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "output",
"label": "output"
"label": "Output options"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "html",
"label": "html"
"label": "HTML options"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "server",
"label": "server"
"label": "Server options"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "security",
"label": "security"
"label": "Security options"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "tools",
"label": "tools"
"label": "Tools options"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "performance",
"label": "performance"
"label": "Performance options"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "module-federation",
"label": "moduleFederation"
"label": "Module Federation options"
}
]
2 changes: 1 addition & 1 deletion website/docs/en/guide/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
"type": "dir-section-header",
"name": "start",
"label": "Getting Started"
"label": "Start"
},
{
"type": "dir-section-header",
Expand Down
4 changes: 2 additions & 2 deletions website/docs/en/plugins/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[
{
"type": "dir",
"type": "dir-section-header",
"name": "list",
"label": "Plugins"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "dev",
"label": "Development"
}
Expand Down
6 changes: 3 additions & 3 deletions website/docs/zh/api/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[
{
"type": "dir",
"type": "dir-section-header",
"name": "start",
"label": "开始"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "javascript-api",
"label": "JavaScript API"
"label": "APIs"
}
]
6 changes: 5 additions & 1 deletion website/docs/zh/community/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
[
{
"type": "section-header",
"label": "社区"
},
"index",
{
"type": "dir",
"type": "dir-section-header",
"name": "releases",
"label": "版本发布"
}
Expand Down
2 changes: 1 addition & 1 deletion website/docs/zh/community/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 社区
# Rsbuild 社区

## 版本

Expand Down
50 changes: 29 additions & 21 deletions website/docs/zh/config/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,62 +1,70 @@
[
{
"type": "section-header",
"label": "总览"
},
{
"type": "file",
"name": "index",
"label": "Overview"
"label": "配置总览"
},
{
"type": "section-header",
"label": "基础选项"
},
"root",
"mode",
"plugins",
"log-level",
"environments",
{
"type": "dir",
"type": "dir-section-header",
"name": "dev",
"label": "dev"
"label": "Dev 选项"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "resolve",
"label": "resolve"
"label": "Resolve 选项"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "source",
"label": "source"
"label": "Source 选项"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "output",
"label": "output"
"label": "Output 选项"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "html",
"label": "html"
"label": "HTML 选项"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "server",
"label": "server"
"label": "Server 选项"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "security",
"label": "security"
"label": "Security 选项"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "tools",
"label": "tools"
"label": "Tools 选项"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "performance",
"label": "performance"
"label": "Performance 选项"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "module-federation",
"label": "moduleFederation"
"label": "Module Federation 选项"
}
]
2 changes: 1 addition & 1 deletion website/docs/zh/config/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ pageType: doc-wide
outline: false
---

# Config 总览
# 配置总览

当前页面列出了 Rsbuild 所有的配置项，请查看 [「配置 Rsbuild」](/guide/configuration/rsbuild) 了解使用方式。

Expand Down
4 changes: 2 additions & 2 deletions website/docs/zh/plugins/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[
{
"type": "dir",
"type": "dir-section-header",
"name": "list",
"label": "插件列表"
},
{
"type": "dir",
"type": "dir-section-header",
"name": "dev",
"label": "开发"
}
Expand Down
2 changes: 1 addition & 1 deletion website/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"@rspress/plugin-llms": "2.0.0-rc.0",
"@rspress/plugin-rss": "2.0.0-rc.0",
"@rspress/plugin-sitemap": "2.0.0-rc.0",
"@rstack-dev/doc-ui": "^1.11.0",
"@rstack-dev/doc-ui": "^1.12.0",
"@shikijs/transformers": "^3.15.0",
"@types/node": "^24.10.1",
"@types/react": "^19.2.5",
Expand Down
4 changes: 2 additions & 2 deletions website/theme/rsbuildPluginOverview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const rsbuildPluginOverview: RsbuildPlugin = {
const files = await glob(globPath);
const groups: Group[] = [
{
name: 'top level',
name: 'base',
items: [
{
text: 'root',
Expand Down Expand Up @@ -66,7 +66,7 @@ export const rsbuildPluginOverview: RsbuildPlugin = {
}

const order = [
'top level',
'base',
'source',
'output',
'html',
Expand Down
Loading