Skip to content

Commit d86b717

Browse files
ArmourArmour
committed
Feature(docs): add basic docs layout
1 parent 892bbd7 commit d86b717

File tree

98 files changed

+74
-39
lines changed

Some content is hidden

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

98 files changed

+74
-39
lines changed

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.DS_Store
22
node_modules
3-
/dist
3+
dist
44

55
# Log files
66
npm-debug.log*

‎docs/.vuepress/config.js

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,10 @@ module.exports = {
7373
}
7474
],
7575
'/features/components/': getSidebarByCategory('components', 'en'),
76-
'/features/pages/': getSidebarByCategory('pages', 'en')
76+
'/features/pages/': getSidebarByCategory('pages', 'en'),
77+
'/features/directives/': getSidebarByCategory('directives', 'en'),
78+
'/features/icons/': getSidebarByCategory('icons', 'en'),
79+
'/features/pwa/': getSidebarByCategory('pwa', 'en')
7780
}
7881
},
7982
'/zh/': {
@@ -120,7 +123,10 @@ module.exports = {
120123
}
121124
],
122125
'/zh/features/components/': getSidebarByCategory('components', 'zh'),
123-
'/zh/features/pages/': getSidebarByCategory('pages', 'zh')
126+
'/zh/features/pages/': getSidebarByCategory('pages', 'zh'),
127+
'/zh/features/directives/': getSidebarByCategory('directives', 'zh'),
128+
'/zh/features/icons/': getSidebarByCategory('icons', 'zh'),
129+
'/zh/features/pwa/': getSidebarByCategory('pwa', 'zh')
124130
}
125131
}
126132
}

‎docs/.vuepress/navbar.js

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -190,17 +190,12 @@ const navbar = {
190190
}
191191
]
192192
},
193-
{
194-
'text-en': 'Pages',
195-
'text-zh': '展示页面',
196-
items: [
197-
{
198-
'text-en': '',
199-
'text-zh': '',
200-
link: '/features/pages/'
201-
}
202-
]
203-
},
193+
// {
194+
// 'text-en': 'Pages',
195+
// 'text-zh': '展示页面',
196+
// items: [
197+
// ]
198+
// },
204199
{
205200
'text-en': 'Directives',
206201
'text-zh': '指令',
@@ -230,12 +225,24 @@ const navbar = {
230225
{
231226
'text-en': 'Icons',
232227
'text-zh': '图标',
233-
link: '/features/icons'
228+
items: [
229+
{
230+
'text-en': 'Svg Icons',
231+
'text-zh': 'svg 图标',
232+
link: '/features/icons/svg-icons'
233+
}
234+
]
234235
},
235236
{
236237
'text-en': 'PWA',
237238
'text-zh': 'PWA',
238-
link: '/features/pwa'
239+
items: [
240+
{
241+
'text-en': 'PWA update popup',
242+
'text-zh': 'PWA 自动更新弹窗',
243+
link: '/features/pwa/service-worker-update-popup'
244+
}
245+
]
239246
}
240247
]
241248
}

‎docs/.vuepress/sidebar.js

Lines changed: 41 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,63 @@ const sidebar = {
55
'/guide/essentials/router-and-nav',
66
'/guide/essentials/permission',
77
'/guide/essentials/tags-view',
8-
'/guide/essentials/new-page',
98
'/guide/essentials/style',
10-
'/guide/essentials/server',
11-
'/guide/essentials/mock-api',
12-
'/guide/essentials/import',
9+
'/guide/essentials/mock',
1310
'/guide/essentials/deploy',
11+
'/guide/essentials/typescript',
1412
'/guide/essentials/env'
1513
],
1614
'advanced': [
1715
'/guide/advanced/cors',
18-
'/guide/advanced/eslint',
19-
'/guide/advanced/git-hook',
20-
'/guide/advanced/style-guide',
21-
'/guide/advanced/lazy-loading',
22-
'/guide/advanced/chart',
23-
'/guide/advanced/icon',
24-
'/guide/advanced/theme',
25-
'/guide/advanced/i18n',
26-
'/guide/advanced/error',
27-
'/guide/advanced/webpack'
16+
'/guide/advanced/remove-unused-components'
2817
],
2918
'components': [
30-
'/features/components/clipboard',
31-
'/features/components/excel',
19+
'/features/components/avatar-upload',
20+
'/features/components/back-to-top',
21+
'/features/components/breadcrumb',
22+
'/features/components/charts',
23+
'/features/components/draggable-kanban',
24+
'/features/components/draggable-list',
25+
'/features/components/draggable-menu',
26+
'/features/components/draggable-select',
27+
'/features/components/dropzone',
28+
'/features/components/error-log',
29+
'/features/components/github-corner',
30+
'/features/components/hamburger',
31+
'/features/components/header-search',
32+
'/features/components/json-editor',
33+
'/features/components/lang-select',
3234
'/features/components/markdown-editor',
35+
'/features/components/material-input',
3336
'/features/components/pagination',
37+
'/features/components/pan-thumb',
3438
'/features/components/rich-editor',
35-
'/features/components/svg-icon',
36-
'/features/components/tree-table'
39+
'/features/components/right-panel',
40+
'/features/components/screenfull',
41+
'/features/components/size-select',
42+
'/features/components/sticky',
43+
'/features/components/text-hover-effect',
44+
'/features/components/theme-picker',
45+
'/features/components/upload-excel',
46+
'/features/components/upload-image'
3747
],
3848
'pages': [
3949
// ...
4050
],
51+
'directives': [
52+
'/features/directives/clipboard',
53+
'/features/directives/draggable-dialog',
54+
'/features/directives/permission',
55+
'/features/directives/waves'
56+
],
57+
'icons': [
58+
'/features/icons/svg-icons'
59+
],
60+
'pwa': [
61+
'/features/pwa/service-worker-update-popup'
62+
],
4163
'other': [
42-
// ...
64+
'/guide/other/faq'
4365
]
4466
}
4567

‎docs/README.md

Lines changed: 1 addition & 1 deletion

‎docs/features/components/avatar-upload.md

‎docs/features/components/back-to-top.md

‎docs/features/components/breadcrumb.md

‎docs/features/components/charts.md

‎docs/features/components/draggable-kanban.md

‎docs/features/components/draggable-list.md

‎docs/features/components/draggable-menu.md

‎docs/features/components/draggable-select.md

‎docs/features/components/dropzone.md

‎docs/features/components/error-log.md

‎docs/features/components/github-corner.md

‎docs/features/components/hamburger.md

‎docs/features/components/header-search.md

‎docs/features/components/json-editor.md

‎docs/features/components/lang-select.md

‎docs/features/components/markdown-editor.md

‎docs/features/components/material-input.md

‎docs/features/components/pagination.md

‎docs/features/components/pan-thumb.md

‎docs/features/components/rich-editor.md

‎docs/features/components/right-panel.md

‎docs/features/components/screenfull.md

‎docs/features/components/size-select.md

‎docs/features/components/sticky.md

‎docs/features/components/text-hover-effect.md

‎docs/features/components/theme-picker.md

‎docs/features/components/upload-excel.md

‎docs/features/components/upload-image.md

‎docs/features/directives/clipboard.md

‎docs/features/directives/draggable-dialog.md

‎docs/features/directives/permission.md

‎docs/features/directives/waves.md

‎docs/features/icons/svg-icons.md

‎docs/features/pwa/service-worker-update-popup.md

‎docs/guide/README.md

Lines changed: 1 addition & 1 deletion

‎docs/guide/advanced/cors.md

‎docs/guide/advanced/remove-unused-components.md

‎docs/guide/essentials/deploy.md

‎docs/guide/essentials/env.md

‎docs/guide/essentials/layout.md

‎docs/guide/essentials/mock.md

‎docs/guide/essentials/permission.md

‎docs/guide/essentials/router-and-nav.md

‎docs/guide/essentials/style.md

‎docs/guide/essentials/tags-view.md

‎docs/guide/essentials/typescript.md

‎docs/zh/README.md

Lines changed: 1 addition & 1 deletion

‎docs/zh/features/components/avatar-upload.md

‎docs/zh/features/components/back-to-top.md

‎docs/zh/features/components/breadcrumb.md

‎docs/zh/features/components/charts.md

‎docs/zh/features/components/draggable-kanban.md

‎docs/zh/features/components/draggable-list.md

‎docs/zh/features/components/draggable-menu.md

‎docs/zh/features/components/draggable-select.md

‎docs/zh/features/components/dropzone.md

‎docs/zh/features/components/error-log.md

‎docs/zh/features/components/github-corner.md

‎docs/zh/features/components/hamburger.md

‎docs/zh/features/components/header-search.md

‎docs/zh/features/components/json-editor.md

‎docs/zh/features/components/lang-select.md

‎docs/zh/features/components/markdown-editor.md

‎docs/zh/features/components/material-input.md

‎docs/zh/features/components/pagination.md

‎docs/zh/features/components/pan-thumb.md

‎docs/zh/features/components/rich-editor.md

‎docs/zh/features/components/right-panel.md

‎docs/zh/features/components/screenfull.md

‎docs/zh/features/components/size-select.md

‎docs/zh/features/components/sticky.md

‎docs/zh/features/components/text-hover-effect.md

‎docs/zh/features/components/theme-picker.md

‎docs/zh/features/components/upload-excel.md

‎docs/zh/features/components/upload-image.md

‎docs/zh/features/directives/clipboard.md

‎docs/zh/features/directives/draggable-dialog.md

‎docs/zh/features/directives/permission.md

‎docs/zh/features/directives/waves.md

‎docs/zh/features/icons/svg-icons.md

‎docs/zh/features/pwa/service-worker-update-popup.md

‎docs/zh/guide/README.md

Lines changed: 1 addition & 1 deletion

‎docs/zh/guide/advanced/cors.md

‎docs/zh/guide/advanced/remove-unused-components.md

‎docs/zh/guide/essentials/deploy.md

‎docs/zh/guide/essentials/env.md

‎docs/zh/guide/essentials/layout.md

‎docs/zh/guide/essentials/mock.md

‎docs/zh/guide/essentials/permission.md

‎docs/zh/guide/essentials/router-and-nav.md

‎docs/zh/guide/essentials/style.md

‎docs/zh/guide/essentials/tags-view.md

‎docs/zh/guide/essentials/typescript.md

0 commit comments

Comments
 (0)