Skip to content

Commit ca2561f

Browse files
Jinjiangyyx990803
authored andcommitted
docs: use VuePress (vuejs#2208)
1 parent 250f7fb commit ca2561f

File tree

207 files changed

+8348
-10502
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

207 files changed

+8348
-10502
lines changed

README.md

+1-1

build/update-docs.sh

-11
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/.vuepress/config.js

+146
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
module.exports = {
2+
locales: {
3+
'/': {
4+
lang: 'en-US',
5+
title: 'Vue Router',
6+
description: 'The official router for Vue.js.'
7+
},
8+
'/zh/': {
9+
lang: 'zh-CN',
10+
title: 'Vue Router',
11+
description: 'Vue.js 官方的路由管理器。'
12+
}
13+
},
14+
serviceWorker: true,
15+
theme: 'vue',
16+
themeConfig: {
17+
repo: 'vuejs/vue-router',
18+
docsDir: 'docs',
19+
locales: {
20+
'/': {
21+
label: 'English',
22+
selectText: 'Languages',
23+
editLinkText: 'Edit this page on GitHub',
24+
nav: [
25+
{
26+
text: 'Getting Started',
27+
link: '/essentials/getting-started'
28+
},
29+
{
30+
text: 'API Reference',
31+
link: '/api/options'
32+
},
33+
{
34+
text: 'Release Notes',
35+
link: 'https://github.com/vuejs/vue-router/releasess'
36+
}
37+
],
38+
sidebar: [
39+
'/installation.md',
40+
'/',
41+
{
42+
title: 'Essentials',
43+
collapsable: false,
44+
children: [
45+
'/essentials/getting-started.md',
46+
'/essentials/dynamic-matching.md',
47+
'/essentials/nested-routes.md',
48+
'/essentials/navigation.md',
49+
'/essentials/named-routes.md',
50+
'/essentials/named-views.md',
51+
'/essentials/redirect-and-alias.md',
52+
'/essentials/passing-props.md',
53+
'/essentials/history-mode.md'
54+
]
55+
},
56+
{
57+
title: 'Advanced',
58+
collapsable: false,
59+
children: [
60+
'/advanced/navigation-guards.md',
61+
'/advanced/meta.md',
62+
'/advanced/transitions.md',
63+
'/advanced/data-fetching.md',
64+
'/advanced/scroll-behavior.md',
65+
'/advanced/lazy-loading.md'
66+
]
67+
},
68+
{
69+
title: 'API Reference',
70+
collapsable: false,
71+
children: [
72+
'/api/options.md',
73+
'/api/router-instance.md',
74+
'/api/route-object.md',
75+
'/api/component-injections.md',
76+
'/api/router-link.md',
77+
'/api/router-view.md'
78+
]
79+
}
80+
]
81+
},
82+
'/zh/': {
83+
label: '简体中文',
84+
selectText: '选择语言',
85+
editLinkText: '在 GitHub 上编辑此页',
86+
nav: [
87+
{
88+
text: '起步',
89+
link: '/zh/essentials/getting-started'
90+
},
91+
{
92+
text: 'API 参考',
93+
link: '/zh/api/options'
94+
},
95+
{
96+
text: '更新记录',
97+
link: 'https://github.com/vuejs/vue-router/releasess'
98+
}
99+
],
100+
sidebar: [
101+
'/zh/installation.md',
102+
'/zh/',
103+
{
104+
title: '基础',
105+
collapsable: false,
106+
children: [
107+
'/zh/essentials/getting-started.md',
108+
'/zh/essentials/dynamic-matching.md',
109+
'/zh/essentials/nested-routes.md',
110+
'/zh/essentials/navigation.md',
111+
'/zh/essentials/named-routes.md',
112+
'/zh/essentials/named-views.md',
113+
'/zh/essentials/redirect-and-alias.md',
114+
'/zh/essentials/passing-props.md',
115+
'/zh/essentials/history-mode.md'
116+
]
117+
},
118+
{
119+
title: '进阶',
120+
collapsable: false,
121+
children: [
122+
'/zh/advanced/navigation-guards.md',
123+
'/zh/advanced/meta.md',
124+
'/zh/advanced/transitions.md',
125+
'/zh/advanced/data-fetching.md',
126+
'/zh/advanced/scroll-behavior.md',
127+
'/zh/advanced/lazy-loading.md'
128+
]
129+
},
130+
{
131+
title: 'API 参考',
132+
collapsable: false,
133+
children: [
134+
'/zh/api/options.md',
135+
'/zh/api/router-instance.md',
136+
'/zh/api/route-object.md',
137+
'/zh/api/component-injections.md',
138+
'/zh/api/router-link.md',
139+
'/zh/api/router-view.md'
140+
]
141+
}
142+
]
143+
}
144+
}
145+
}
146+
}

docs/.vuepress/public/_redirects

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# redirect old urls to root
2+
/en/* /:splat
3+
/zh-cn/* /zh/:splat

docs/README.md

+18

docs/en/advanced/lazy-loading.md renamed to docs/advanced/lazy-loading.md

+4-2

docs/en/advanced/navigation-guards.md renamed to docs/advanced/navigation-guards.md

+6-6

docs/en/advanced/scroll-behavior.md renamed to docs/advanced/scroll-behavior.md

+1-1

docs/en/advanced/transitions.md renamed to docs/advanced/transitions.md

+2-2

docs/en/api/component-injections.md renamed to docs/api/component-injections.md

+4-4

docs/en/api/options.md renamed to docs/api/options.md

+8-8

docs/en/api/route-object.md renamed to docs/api/route-object.md

+1-1

0 commit comments

Comments
 (0)