Skip to content

Commit 2d52ada

Browse files
0xJacky0xJacky
committed
docs(wip): documentation for v2
1 parent 712a4d2 commit 2d52ada

File tree

16 files changed

+466
-275
lines changed

16 files changed

+466
-275
lines changed

‎docs/.vitepress/config/en.ts

Lines changed: 47 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,54 @@
1-
import {LocaleSpecificConfig, DefaultTheme} from "vitepress"
1+
import {LocaleSpecificConfig, DefaultTheme} from 'vitepress'
22
import {demoUrl} from './common'
33

44
export const enConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
5-
themeConfig: {
6-
nav: [
7-
{text: 'Home', link: '/'},
8-
{text: 'Guide', link: '/guide/about'},
9-
{text: 'Demo', link: demoUrl}
10-
],
5+
themeConfig: {
6+
nav: [
7+
{text: 'Home', link: '/'},
8+
{text: 'Guide', link: '/guide/about'},
9+
{text: 'Demo', link: demoUrl}
10+
],
1111

12-
sidebar: {
13-
'/guide/': [
14-
{
15-
text: 'Introduction',
16-
collapsed: false,
17-
items: [
18-
{text: 'What is Nginx UI?', link: '/guide/about'},
19-
{text: 'Getting Started', link: '/guide/getting-started'},
20-
{text: 'Install Script', link: '/guide/install-script-linux'}
21-
]
22-
},
23-
{
24-
text: 'Development',
25-
collapsed: false,
26-
items: [
27-
{text: 'Build', link: '/guide/build'},
28-
{text: 'Project Structure', link: '/guide/project-structure'},
29-
{text: 'Config Template', link: '/guide/nginx-ui-template'},
30-
{text: 'Contributing', link: '/guide/contributing'}
31-
]
32-
},
33-
{
34-
text: 'Configuration',
35-
collapsed: false,
36-
items: [
37-
{text: 'Server', link: '/guide/config-server'},
38-
{text: 'Nginx Log', link: '/guide/config-nginx-log'},
39-
{text: 'Open AI', link: '/guide/config-openai'}
40-
]
41-
},
42-
{
43-
text: 'Appendix',
44-
collapsed: false,
45-
items: [
46-
{text: 'Nginx Proxy Example', link: '/guide/nginx-proxy-example'},
47-
{text: 'License', link: '/guide/license'}
48-
]
49-
}
50-
],
12+
sidebar: {
13+
'/guide/': [
14+
{
15+
text: 'Introduction',
16+
collapsed: false,
17+
items: [
18+
{text: 'What is Nginx UI?', link: '/guide/about'},
19+
{text: 'Getting Started', link: '/guide/getting-started'},
20+
{text: 'Install Script', link: '/guide/install-script-linux'}
21+
]
5122
},
23+
{
24+
text: 'Development',
25+
collapsed: false,
26+
items: [
27+
{text: 'Build', link: '/guide/build'},
28+
{text: 'Project Structure', link: '/guide/project-structure'},
29+
{text: 'Config Template', link: '/guide/nginx-ui-template'},
30+
{text: 'Contributing', link: '/guide/contributing'}
31+
]
32+
},
33+
{
34+
text: 'Configuration',
35+
collapsed: false,
36+
items: [
37+
{text: 'Server', link: '/guide/config-server'},
38+
{text: 'Nginx Log', link: '/guide/config-nginx'},
39+
{text: 'Open AI', link: '/guide/config-openai'},
40+
{text: 'Casdoor', link: '/guide/config-casdoor'}
41+
]
42+
},
43+
{
44+
text: 'Appendix',
45+
collapsed: false,
46+
items: [
47+
{text: 'Nginx Proxy Example', link: '/guide/nginx-proxy-example'},
48+
{text: 'License', link: '/guide/license'}
49+
]
50+
}
51+
]
5252
}
53+
}
5354
}

‎docs/.vitepress/config/zh_CN.ts

Lines changed: 84 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,97 @@
1-
import {LocaleSpecificConfig, DefaultTheme} from "vitepress"
1+
import {LocaleSpecificConfig, DefaultTheme} from 'vitepress'
22
import {demoUrl, editLinkPattern} from './common'
33

44
export const zhCNConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
5-
themeConfig: {
6-
nav: [
7-
{text: '首页', link: '/zh_CN/'},
8-
{text: '手册', link: '/zh_CN/guide/about'},
9-
{text: '演示', link: demoUrl}
10-
],
5+
themeConfig: {
6+
nav: [
7+
{text: '首页', link: '/zh_CN/'},
8+
{text: '手册', link: '/zh_CN/guide/about'},
9+
{text: '演示', link: demoUrl}
10+
],
1111

12-
editLink: {
13-
text: '编辑此页',
14-
pattern: editLinkPattern
15-
},
12+
editLink: {
13+
text: '编辑此页',
14+
pattern: editLinkPattern
15+
},
1616

17-
sidebar: {
18-
'/zh_CN/guide/': [
19-
{
20-
text: '介绍',
21-
collapsed: false,
22-
items: [
23-
{text: '何为 Nginx UI?', link: '/zh_CN/guide/about'},
24-
{text: '即刻开始', link: '/zh_CN/guide/getting-started'},
25-
{text: '安装脚本', link: '/zh_CN/guide/install-script-linux'}
26-
]
27-
},
28-
{
29-
text: '开发',
30-
collapsed: false,
31-
items: [
32-
{text: '构建', link: '/zh_CN/guide/build'},
33-
{text: '项目结构', link: '/zh_CN/guide/project-structure'},
34-
{text: '配置模板', link: '/zh_CN/guide/nginx-ui-template'},
35-
{text: '贡献代码', link: '/zh_CN/guide/contributing'}
36-
]
37-
},
38-
{
39-
text: '配置',
40-
collapsed: false,
41-
items: [
42-
{text: '服务端', link: '/zh_CN/guide/config-server'},
43-
{text: 'Nginx 日志', link: '/zh_CN/guide/config-nginx-log'},
44-
{text: 'Open AI', link: '/zh_CN/guide/config-openai'}
45-
]
46-
},
47-
{
48-
text: '附录',
49-
collapsed: false,
50-
items: [
51-
{text: 'Nginx 代理示例', link: '/zh_CN/guide/nginx-proxy-example'},
52-
{text: '开源协议', link: '/zh_CN/guide/license'}
53-
]
54-
}
55-
]
17+
sidebar: {
18+
'/zh_CN/guide/': [
19+
{
20+
text: '介绍',
21+
collapsed: false,
22+
items: [
23+
{text: '何为 Nginx UI?', link: '/zh_CN/guide/about'},
24+
{text: '即刻开始', link: '/zh_CN/guide/getting-started'},
25+
{text: '安装脚本', link: '/zh_CN/guide/install-script-linux'}
26+
]
5627
},
57-
58-
docFooter: {
59-
prev: '上一页',
60-
next: '下一页',
28+
{
29+
text: '开发',
30+
collapsed: false,
31+
items: [
32+
{text: '构建', link: '/zh_CN/guide/build'},
33+
{text: '项目结构', link: '/zh_CN/guide/project-structure'},
34+
{text: '配置模板', link: '/zh_CN/guide/nginx-ui-template'},
35+
{text: '贡献代码', link: '/zh_CN/guide/contributing'}
36+
]
6137
},
62-
returnToTopLabel: '返回顶部',
63-
outlineTitle: '导航栏',
64-
darkModeSwitchLabel: '外观',
65-
sidebarMenuLabel: '归档',
66-
lastUpdatedText: '更新于',
38+
{
39+
text: '配置',
40+
collapsed: false,
41+
items: [
42+
{text: '服务端', link: '/zh_CN/guide/config-server'},
43+
{text: 'Nginx', link: '/zh_CN/guide/config-nginx'},
44+
{text: 'Open AI', link: '/zh_CN/guide/config-openai'},
45+
{text: 'Casdoor', link: '/zh_CN/guide/config-casdoor'}
46+
]
47+
},
48+
{
49+
text: '附录',
50+
collapsed: false,
51+
items: [
52+
{text: 'Nginx 代理示例', link: '/zh_CN/guide/nginx-proxy-example'},
53+
{text: '开源协议', link: '/zh_CN/guide/license'}
54+
]
55+
}
56+
]
57+
},
6758

68-
search: {
69-
provider: 'local',
70-
options: {
71-
locales: {
72-
zh_CN: {
73-
translations: {
74-
button: {
75-
buttonText: '搜索文档',
76-
buttonAriaLabel: '搜索文档'
77-
},
78-
modal: {
79-
noResultsText: '无法找到相关结果',
80-
resetButtonTitle: '清除查询条件',
81-
footer: {
82-
selectText: '选择',
83-
navigateText: '切换',
84-
closeText: '关闭'
85-
}
86-
}
87-
}
88-
}
59+
docFooter: {
60+
prev: '上一页',
61+
next: '下一页'
62+
},
63+
returnToTopLabel: '返回顶部',
64+
outline: {
65+
label: '导航栏'
66+
},
67+
darkModeSwitchLabel: '外观',
68+
sidebarMenuLabel: '归档',
69+
lastUpdated: {
70+
text: '更新于'
71+
},
72+
search: {
73+
provider: 'local',
74+
options: {
75+
locales: {
76+
zh_CN: {
77+
translations: {
78+
button: {
79+
buttonText: '搜索文档',
80+
buttonAriaLabel: '搜索文档'
81+
},
82+
modal: {
83+
noResultsText: '无法找到相关结果',
84+
resetButtonTitle: '清除查询条件',
85+
footer: {
86+
selectText: '选择',
87+
navigateText: '切换',
88+
closeText: '关闭'
8989
}
90+
}
9091
}
92+
}
9193
}
94+
}
9295
}
96+
}
9397
}

0 commit comments

Comments
 (0)