Skip to content

Commit 34f517f

Browse files
MolunerfinnMolunerfinn
committed
📝 Docs: update docs
1 parent 4f66bbb commit 34f517f

File tree

18 files changed

+1520
-1268
lines changed

18 files changed

+1520
-1268
lines changed

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,5 @@ docs/.vitepress/dist
6565
docs/.vitepress/cache
6666

6767
.temp/
68-
.serena/
68+
.serena/
69+
.DS_Store

‎docs/.vitepress/config.mts‎

Lines changed: 52 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { defineConfig, DefaultTheme } from 'vitepress'
1+
import type { DefaultTheme } from 'vitepress'
22
import { getNestedSidebarItems } from './utils/sidebar'
33

44
const EDIT_LINK_PATTERN = 'https://github.com/PicGo/PicGo-Doc/edit/master/docs/:path'
@@ -15,45 +15,48 @@ const commonNavList = [
1515
}
1616
]
1717

18+
// --- Chinese Config (Now at /zh/) ---
19+
1820
const zhNav = [
19-
{ text: '高级技巧', link: '/guide/advance' },
21+
{ text: '高级技巧', link: '/zh/guide/advance' },
2022
...commonNavList
2123
]
2224

23-
2425
const zhSidebar: DefaultTheme.SidebarItem[] = [
2526
{
2627
text: '指南',
2728
items: [
28-
{ text: '应用介绍', link: '/guide/', items: getNestedSidebarItems('/guide/'), collapsed: true },
29-
{ text: '快速开始', link: '/guide/getting-started', items: getNestedSidebarItems('/guide/getting-started'), collapsed: true },
30-
{ text: '配置手册', link: '/guide/config', items: getNestedSidebarItems('/guide/config'), collapsed: true },
31-
{ text: '高级技巧', link: '/guide/advance', items: getNestedSidebarItems('/guide/advance'), collapsed: true }
29+
{ text: '应用介绍', link: '/zh/guide/', items: getNestedSidebarItems('/zh/guide/'), collapsed: true },
30+
{ text: '快速开始', link: '/zh/guide/getting-started', items: getNestedSidebarItems('/zh/guide/getting-started'), collapsed: true },
31+
{ text: '配置手册', link: '/zh/guide/config', items: getNestedSidebarItems('/zh/guide/config'), collapsed: true },
32+
{ text: '高级技巧', link: '/zh/guide/advance', items: getNestedSidebarItems('/zh/guide/advance'), collapsed: true }
3233
]
3334
}
3435
]
3536

37+
// --- English Config (Now at Root /) ---
38+
3639
const enNav = [
37-
{ text: 'Advance Usage', link: '/en/guide/advance' },
40+
{ text: 'Advance Usage', link: '/guide/advance' },
3841
...commonNavList
3942
]
4043

4144
const enSidebar = [
4245
{
4346
text: 'Guidelines',
4447
items: [
45-
{ text: 'App Overview', link: '/en/guide/', items: getNestedSidebarItems('/en/guide/'), collapsed: true },
46-
{ text: 'Getting Started', link: '/en/guide/getting-started', items: getNestedSidebarItems('/en/guide/getting-started'), collapsed: true },
47-
{ text: 'Configuration Manual', link: '/en/guide/config', items: getNestedSidebarItems('/en/guide/config'), collapsed: true },
48-
{ text: 'Advanced Usage', link: '/en/guide/advance', items: getNestedSidebarItems('/en/guide/advance'), collapsed: true }
48+
{ text: 'App Overview', link: '/guide/', items: getNestedSidebarItems('/guide/'), collapsed: true },
49+
{ text: 'Getting Started', link: '/guide/getting-started', items: getNestedSidebarItems('/guide/getting-started'), collapsed: true },
50+
{ text: 'Configuration Manual', link: '/guide/config', items: getNestedSidebarItems('/guide/config'), collapsed: true },
51+
{ text: 'Advanced Usage', link: '/guide/advance', items: getNestedSidebarItems('/guide/advance'), collapsed: true }
4952
]
5053
}
5154
]
5255

5356
const zhThemeConfig = {
5457
nav: zhNav,
5558
sidebar: {
56-
'/guide/': zhSidebar
59+
'/zh/guide/': zhSidebar
5760
},
5861
editLink: {
5962
pattern: EDIT_LINK_PATTERN,
@@ -68,7 +71,7 @@ const zhThemeConfig = {
6871
const enThemeConfig = {
6972
nav: enNav,
7073
sidebar: {
71-
'/en/guide/': enSidebar
74+
'/guide/': enSidebar
7275
},
7376
editLink: {
7477
pattern: EDIT_LINK_PATTERN,
@@ -80,9 +83,9 @@ const enThemeConfig = {
8083
}
8184
} as const
8285

83-
export default defineConfig({
86+
export default {
8487
title: 'PicGo',
85-
description: '图片上传、管理新体验',
88+
description: 'New Experience of Pictures Uploading and Management',
8689
base: '/PicGo-Doc/',
8790
head: [
8891
['meta', { name: 'google-site-verification', content: 'I9agtjzUmnyUxzdpci2kQuXzlOgw7qBLqR5w6PgUnjQ' }],
@@ -107,29 +110,6 @@ export default defineConfig({
107110
options: {
108111
locales: {
109112
root: {
110-
translations: {
111-
button: {
112-
buttonText: '搜索',
113-
buttonAriaLabel: '搜索'
114-
},
115-
modal: {
116-
displayDetails: '显示详细列表',
117-
resetButtonTitle: '重置搜索',
118-
backButtonTitle: '关闭搜索',
119-
noResultsText: '没有找到结果',
120-
footer: {
121-
selectText: '选择',
122-
selectKeyAriaLabel: '回车',
123-
navigateText: '导航',
124-
navigateUpKeyAriaLabel: '上箭头',
125-
navigateDownKeyAriaLabel: '下箭头',
126-
closeText: '关闭',
127-
closeKeyAriaLabel: 'Esc'
128-
}
129-
}
130-
}
131-
},
132-
en: {
133113
translations: {
134114
button: {
135115
buttonText: 'Search',
@@ -151,27 +131,50 @@ export default defineConfig({
151131
}
152132
}
153133
}
134+
},
135+
zh: {
136+
translations: {
137+
button: {
138+
buttonText: '搜索',
139+
buttonAriaLabel: '搜索'
140+
},
141+
modal: {
142+
displayDetails: '显示详细列表',
143+
resetButtonTitle: '重置搜索',
144+
backButtonTitle: '关闭搜索',
145+
noResultsText: '没有找到结果',
146+
footer: {
147+
selectText: '选择',
148+
selectKeyAriaLabel: '回车',
149+
navigateText: '导航',
150+
navigateUpKeyAriaLabel: '上箭头',
151+
navigateDownKeyAriaLabel: '下箭头',
152+
closeText: '关闭',
153+
closeKeyAriaLabel: 'Esc'
154+
}
155+
}
156+
}
154157
}
155158
}
156159
}
157160
}
158161
},
159162
locales: {
160163
root: {
161-
label: '简体中文',
162-
lang: 'zh-CN',
163-
title: 'PicGo',
164-
description: '图片上传、管理新体验',
165-
link: '/',
166-
themeConfig: zhThemeConfig
167-
},
168-
en: {
169164
label: 'English',
170165
lang: 'en-US',
171166
title: 'PicGo',
172167
description: 'New Experience of Pictures Uploading and Management',
173-
link: '/en/',
168+
link: '/',
174169
themeConfig: enThemeConfig
170+
},
171+
zh: {
172+
label: '简体中文',
173+
lang: 'zh-CN',
174+
title: 'PicGo',
175+
description: '图片上传、管理新体验',
176+
link: '/zh/',
177+
themeConfig: zhThemeConfig
175178
}
176179
}
177-
})
180+
}

‎docs/.vitepress/config.ts‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
import type { DefaultTheme } from 'vitepress'
2+
import { getNestedSidebarItems } from './utils/sidebar'
3+
4+
const EDIT_LINK_PATTERN = 'https://github.com/PicGo/PicGo-Doc/edit/master/docs/:path'
5+
6+
const commonNavList = [
7+
{
8+
text: 'Download', link: 'https://github.com/Molunerfinn/PicGo/releases',
9+
},
10+
{
11+
text: 'PicGo-Core', link: 'https://github.com/PicGo/PicGo-Core',
12+
},
13+
{
14+
text: 'Awesome-PicGo', link: 'https://github.com/PicGo/Awesome-PicGo'
15+
}
16+
]
17+
18+
// --- Chinese Config (Now at /zh/) ---
19+
20+
const zhNav = [
21+
{ text: '高级技巧', link: '/zh/guide/advance' },
22+
...commonNavList
23+
]
24+
25+
const zhSidebar: DefaultTheme.SidebarItem[] = [
26+
{
27+
text: '指南',
28+
items: [
29+
{ text: '应用介绍', link: '/zh/guide/', items: getNestedSidebarItems('/zh/guide/'), collapsed: true },
30+
{ text: '快速开始', link: '/zh/guide/getting-started', items: getNestedSidebarItems('/zh/guide/getting-started'), collapsed: true },
31+
{ text: '配置手册', link: '/zh/guide/config', items: getNestedSidebarItems('/zh/guide/config'), collapsed: true },
32+
{ text: '高级技巧', link: '/zh/guide/advance', items: getNestedSidebarItems('/zh/guide/advance'), collapsed: true }
33+
]
34+
}
35+
]
36+
37+
// --- English Config (Now at Root /) ---
38+
39+
const enNav = [
40+
{ text: 'Advance Usage', link: '/guide/advance' },
41+
...commonNavList
42+
]
43+
44+
const enSidebar = [
45+
{
46+
text: 'Guidelines',
47+
items: [
48+
{ text: 'App Overview', link: '/guide/', items: getNestedSidebarItems('/guide/'), collapsed: true },
49+
{ text: 'Getting Started', link: '/guide/getting-started', items: getNestedSidebarItems('/guide/getting-started'), collapsed: true },
50+
{ text: 'Configuration Manual', link: '/guide/config', items: getNestedSidebarItems('/guide/config'), collapsed: true },
51+
{ text: 'Advanced Usage', link: '/guide/advance', items: getNestedSidebarItems('/guide/advance'), collapsed: true }
52+
]
53+
}
54+
]
55+
56+
const zhThemeConfig = {
57+
nav: zhNav,
58+
sidebar: {
59+
'/zh/guide/': zhSidebar
60+
},
61+
editLink: {
62+
pattern: EDIT_LINK_PATTERN,
63+
text: '在 GitHub 上编辑此页'
64+
},
65+
outline: {
66+
label: '本页目录',
67+
level: 'deep'
68+
}
69+
} as const
70+
71+
const enThemeConfig = {
72+
nav: enNav,
73+
sidebar: {
74+
'/guide/': enSidebar
75+
},
76+
editLink: {
77+
pattern: EDIT_LINK_PATTERN,
78+
text: 'Edit this page on GitHub'
79+
},
80+
outline: {
81+
label: 'On this page',
82+
level: 'deep'
83+
}
84+
} as const
85+
86+
export default {
87+
title: 'PicGo',
88+
description: 'New Experience of Pictures Uploading and Management',
89+
base: '/PicGo-Doc/',
90+
head: [
91+
['meta', { name: 'google-site-verification', content: 'I9agtjzUmnyUxzdpci2kQuXzlOgw7qBLqR5w6PgUnjQ' }],
92+
[
93+
'link',
94+
{
95+
rel: 'icon',
96+
href: 'https://raw.githubusercontent.com/Molunerfinn/test/master/picgo/New%20LOGO-150.png'
97+
}
98+
],
99+
],
100+
sitemap: {
101+
hostname: 'https://picgo.github.io/PicGo-Doc/'
102+
},
103+
themeConfig: {
104+
logo: 'https://pics.molunerfinn.com/doc/picgo-logo.png',
105+
socialLinks: [
106+
{ icon: 'github', link: 'https://github.com/Molunerfinn/PicGo' }
107+
],
108+
search: {
109+
provider: 'local',
110+
options: {
111+
locales: {
112+
root: {
113+
translations: {
114+
button: {
115+
buttonText: 'Search',
116+
buttonAriaLabel: 'Search'
117+
},
118+
modal: {
119+
displayDetails: 'Display detailed results',
120+
resetButtonTitle: 'Clear search',
121+
backButtonTitle: 'Close search',
122+
noResultsText: 'No results for this query',
123+
footer: {
124+
selectText: 'select',
125+
selectKeyAriaLabel: 'Enter',
126+
navigateText: 'navigate',
127+
navigateUpKeyAriaLabel: 'Arrow up',
128+
navigateDownKeyAriaLabel: 'Arrow down',
129+
closeText: 'close',
130+
closeKeyAriaLabel: 'Escape'
131+
}
132+
}
133+
}
134+
},
135+
zh: {
136+
translations: {
137+
button: {
138+
buttonText: '搜索',
139+
buttonAriaLabel: '搜索'
140+
},
141+
modal: {
142+
displayDetails: '显示详细列表',
143+
resetButtonTitle: '重置搜索',
144+
backButtonTitle: '关闭搜索',
145+
noResultsText: '没有找到结果',
146+
footer: {
147+
selectText: '选择',
148+
selectKeyAriaLabel: '回车',
149+
navigateText: '导航',
150+
navigateUpKeyAriaLabel: '上箭头',
151+
navigateDownKeyAriaLabel: '下箭头',
152+
closeText: '关闭',
153+
closeKeyAriaLabel: 'Esc'
154+
}
155+
}
156+
}
157+
}
158+
}
159+
}
160+
}
161+
},
162+
locales: {
163+
root: {
164+
label: 'English',
165+
lang: 'en-US',
166+
title: 'PicGo',
167+
description: 'New Experience of Pictures Uploading and Management',
168+
link: '/',
169+
themeConfig: enThemeConfig
170+
},
171+
zh: {
172+
label: '简体中文',
173+
lang: 'zh-CN',
174+
title: 'PicGo',
175+
description: '图片上传、管理新体验',
176+
link: '/zh/',
177+
themeConfig: zhThemeConfig
178+
}
179+
}
180+
}

0 commit comments

Comments
 (0)