Skip to content

Commit 8948a43

Browse files
MolunerfinnMolunerfinn
committed
feat: add en docs for default
1 parent 2a139a5 commit 8948a43

File tree

24 files changed

+4656
-3143
lines changed

24 files changed

+4656
-3143
lines changed

‎commitlint.config.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export default { extends: ['@commitlint/config-conventional'] };

‎docs/.vitepress/config.mts‎

Lines changed: 135 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,47 @@ const communityNavItems = [
1414
}
1515
]
1616

17+
// --- Chinese Config (Now at /zh/) ---
18+
1719
const zhNav = [
18-
{
19-
text: '指南',
20-
link: '/guide/'
21-
},
20+
{ text: '指南', link: '/zh/guide/' },
2221
{
2322
text: '插件开发指南',
2423
items: [
25-
{ text: '插件开发', link: '/dev-guide/cli' },
26-
{ text: 'GUI 插件开发', link: '/dev-guide/gui' },
27-
{ text: '插件测试与发布', link: '/dev-guide/deploy' }
24+
{ text: '插件开发', link: '/zh/dev-guide/cli' },
25+
{ text: 'GUI 插件开发', link: '/zh/dev-guide/gui' },
26+
{ text: '插件测试与发布', link: '/zh/dev-guide/deploy' }
2827
]
2928
},
29+
{ text: 'API 列表', link: '/zh/api/' },
30+
...communityNavItems
31+
]
32+
33+
// --- English Config (Default at /) ---
34+
35+
const enNav = [
36+
{ text: 'Guide', link: '/guide/' },
3037
{
31-
text: 'API 列表',
32-
link: '/api/'
38+
text: 'Plugin Dev',
39+
items: [
40+
{ text: 'Plugin Development', link: '/dev-guide/cli' },
41+
{ text: 'GUI Plugin Development', link: '/dev-guide/gui' },
42+
{ text: 'Testing & Publishing', link: '/dev-guide/deploy' }
43+
]
3344
},
45+
{ text: 'API', link: '/api/' },
3446
...communityNavItems
3547
]
3648

3749
const zhGuideSidebar: DefaultTheme.SidebarItem[] = [
3850
{
3951
text: '指南',
4052
items: [
41-
{ text: '介绍', link: '/guide/', items: getNestedSidebarItems('/guide/'), collapsed: true },
42-
{ text: '快速开始', link: '/guide/getting-started', items: getNestedSidebarItems('/guide/getting-started'), collapsed: true },
43-
{ text: '配置文件', link: '/guide/config', items: getNestedSidebarItems('/guide/config'), collapsed: true },
44-
{ text: '命令列表', link: '/guide/commands', items: getNestedSidebarItems('/guide/commands'), collapsed: true },
45-
{ text: 'Node.js 使用', link: '/guide/use-in-node', items: getNestedSidebarItems('/guide/use-in-node'), collapsed: true }
53+
{ text: '介绍', link: '/zh/guide/', items: getNestedSidebarItems('/zh/guide/'), collapsed: true },
54+
{ text: '快速开始', link: '/zh/guide/getting-started', items: getNestedSidebarItems('/zh/guide/getting-started'), collapsed: true },
55+
{ text: '配置文件', link: '/zh/guide/config', items: getNestedSidebarItems('/zh/guide/config'), collapsed: true },
56+
{ text: '命令列表', link: '/zh/guide/commands', items: getNestedSidebarItems('/zh/guide/commands'), collapsed: true },
57+
{ text: 'Node.js 使用', link: '/zh/guide/use-in-node', items: getNestedSidebarItems('/zh/guide/use-in-node'), collapsed: true }
4658
]
4759
}
4860
]
@@ -51,9 +63,9 @@ const zhDevSidebar: DefaultTheme.SidebarItem[] = [
5163
{
5264
text: '插件开发指南',
5365
items: [
54-
{ text: '插件开发', link: '/dev-guide/cli', items: getNestedSidebarItems('/dev-guide/cli'), collapsed: true },
55-
{ text: 'GUI 插件开发', link: '/dev-guide/gui', items: getNestedSidebarItems('/dev-guide/gui'), collapsed: true },
56-
{ text: '插件测试与发布', link: '/dev-guide/deploy', items: getNestedSidebarItems('/dev-guide/deploy'), collapsed: true }
66+
{ text: '插件开发', link: '/zh/dev-guide/cli', items: getNestedSidebarItems('/zh/dev-guide/cli'), collapsed: true },
67+
{ text: 'GUI 插件开发', link: '/zh/dev-guide/gui', items: getNestedSidebarItems('/zh/dev-guide/gui'), collapsed: true },
68+
{ text: '插件测试与发布', link: '/zh/dev-guide/deploy', items: getNestedSidebarItems('/zh/dev-guide/deploy'), collapsed: true }
5769
]
5870
}
5971
]
@@ -62,17 +74,48 @@ const zhApiSidebar: DefaultTheme.SidebarItem[] = [
6274
{
6375
text: 'API 列表',
6476
items: [
65-
{ text: 'API 列表', link: '/api/', items: getNestedSidebarItems('/api/'), collapsed: true }
77+
{ text: 'API 列表', link: '/zh/api/', items: getNestedSidebarItems('/zh/api/'), collapsed: true }
78+
]
79+
}
80+
]
81+
82+
const enGuideSidebar: DefaultTheme.SidebarItem[] = [
83+
{
84+
text: 'Guide',
85+
items: [
86+
{ text: 'Overview', link: '/guide/', items: getNestedSidebarItems('/guide/'), collapsed: true },
87+
{ text: 'Getting Started', link: '/guide/getting-started', items: getNestedSidebarItems('/guide/getting-started'), collapsed: true },
88+
{ text: 'Configuration', link: '/guide/config', items: getNestedSidebarItems('/guide/config'), collapsed: true },
89+
{ text: 'CLI Commands', link: '/guide/commands', items: getNestedSidebarItems('/guide/commands'), collapsed: true },
90+
{ text: 'Use in Node.js', link: '/guide/use-in-node', items: getNestedSidebarItems('/guide/use-in-node'), collapsed: true }
91+
]
92+
}
93+
]
94+
95+
const enDevSidebar: DefaultTheme.SidebarItem[] = [
96+
{
97+
text: 'Plugin Development',
98+
items: [
99+
{ text: 'Plugin Development', link: '/dev-guide/cli', items: getNestedSidebarItems('/dev-guide/cli'), collapsed: true },
100+
{ text: 'GUI Plugin Development', link: '/dev-guide/gui', items: getNestedSidebarItems('/dev-guide/gui'), collapsed: true },
101+
{ text: 'Testing & Publishing', link: '/dev-guide/deploy', items: getNestedSidebarItems('/dev-guide/deploy'), collapsed: true }
66102
]
67103
}
68104
]
69105

106+
const enApiSidebar: DefaultTheme.SidebarItem[] = [
107+
{
108+
text: 'API',
109+
items: [{ text: 'API', link: '/api/', items: getNestedSidebarItems('/api/'), collapsed: true }]
110+
}
111+
]
112+
70113
const zhThemeConfig = {
71114
nav: zhNav,
72115
sidebar: {
73-
'/guide/': zhGuideSidebar,
74-
'/dev-guide/': zhDevSidebar,
75-
'/api/': zhApiSidebar
116+
'/zh/guide/': zhGuideSidebar,
117+
'/zh/dev-guide/': zhDevSidebar,
118+
'/zh/api/': zhApiSidebar
76119
},
77120
editLink: {
78121
pattern: EDIT_LINK_PATTERN,
@@ -84,9 +127,26 @@ const zhThemeConfig = {
84127
}
85128
} as const
86129

130+
const enThemeConfig = {
131+
nav: enNav,
132+
sidebar: {
133+
'/guide/': enGuideSidebar,
134+
'/dev-guide/': enDevSidebar,
135+
'/api/': enApiSidebar
136+
},
137+
editLink: {
138+
pattern: EDIT_LINK_PATTERN,
139+
text: 'Edit this page on GitHub'
140+
},
141+
outline: {
142+
label: 'On this page',
143+
level: 'deep'
144+
}
145+
} as const
146+
87147
export default defineConfig({
88148
title: 'PicGo-Core',
89-
description: 'PicGo 的核心组件',
149+
description: 'The core engine behind PicGo',
90150
base: '/PicGo-Core-Doc/',
91151
head: [
92152
['meta', { name: 'google-site-verification', content: 'I9agtjzUmnyUxzdpci2kQuXzlOgw7qBLqR5w6PgUnjQ' }],
@@ -109,24 +169,51 @@ export default defineConfig({
109169
search: {
110170
provider: 'local',
111171
options: {
112-
translations: {
113-
button: {
114-
buttonText: '搜索',
115-
buttonAriaLabel: '搜索'
172+
locales: {
173+
root: {
174+
translations: {
175+
button: {
176+
buttonText: 'Search',
177+
buttonAriaLabel: 'Search'
178+
},
179+
modal: {
180+
displayDetails: 'Display detailed results',
181+
resetButtonTitle: 'Clear search',
182+
backButtonTitle: 'Close search',
183+
noResultsText: 'No results for this query',
184+
footer: {
185+
selectText: 'select',
186+
selectKeyAriaLabel: 'Enter',
187+
navigateText: 'navigate',
188+
navigateUpKeyAriaLabel: 'Arrow up',
189+
navigateDownKeyAriaLabel: 'Arrow down',
190+
closeText: 'close',
191+
closeKeyAriaLabel: 'Escape'
192+
}
193+
}
194+
}
116195
},
117-
modal: {
118-
displayDetails: '显示详细列表',
119-
resetButtonTitle: '重置搜索',
120-
backButtonTitle: '关闭搜索',
121-
noResultsText: '没有找到结果',
122-
footer: {
123-
selectText: '选择',
124-
selectKeyAriaLabel: '回车',
125-
navigateText: '导航',
126-
navigateUpKeyAriaLabel: '上箭头',
127-
navigateDownKeyAriaLabel: '下箭头',
128-
closeText: '关闭',
129-
closeKeyAriaLabel: 'Esc'
196+
zh: {
197+
translations: {
198+
button: {
199+
buttonText: '搜索',
200+
buttonAriaLabel: '搜索'
201+
},
202+
modal: {
203+
displayDetails: '显示详细列表',
204+
resetButtonTitle: '重置搜索',
205+
backButtonTitle: '关闭搜索',
206+
noResultsText: '没有找到结果',
207+
footer: {
208+
selectText: '选择',
209+
selectKeyAriaLabel: '回车',
210+
navigateText: '导航',
211+
navigateUpKeyAriaLabel: '上箭头',
212+
navigateDownKeyAriaLabel: '下箭头',
213+
closeText: '关闭',
214+
closeKeyAriaLabel: 'Esc'
215+
}
216+
}
130217
}
131218
}
132219
}
@@ -139,11 +226,19 @@ export default defineConfig({
139226
},
140227
locales: {
141228
root: {
229+
label: 'English',
230+
lang: 'en-US',
231+
title: 'PicGo-Core',
232+
description: 'The core engine behind PicGo',
233+
link: '/',
234+
themeConfig: enThemeConfig
235+
},
236+
zh: {
142237
label: '简体中文',
143238
lang: 'zh-CN',
144239
title: 'PicGo-Core',
145240
description: 'PicGo 的核心组件',
146-
link: '/',
241+
link: '/zh/',
147242
themeConfig: zhThemeConfig
148243
}
149244
}

0 commit comments

Comments
 (0)