Skip to content

Commit da62b06

Browse files
committed
feat: first draft v5 docs
1 parent 72a0e53 commit da62b06

Some content is hidden

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

49 files changed

+1801
-1202
lines changed

.vuepress/config.js

+17-40
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,7 @@ module.exports = {
88
lang: 'en',
99
title: 'Vuesion',
1010
description:
11-
'Vuesion is a boilerplate that helps product teams build faster than ever with fewer headaches and modern best practices across engineering & design.',
12-
},
13-
'/ru/': {
14-
lang: 'ru-Ru',
15-
title: 'Vuesion',
16-
description:
17-
'Vuesion - стартовая сборка Vue JS для быстрого прототипирования с готовой архитектурой для больших приложений',
18-
},
19-
'/ko/': {
20-
lang: 'ko',
21-
title: 'Vuesion',
22-
description:
23-
'Vuesion은 설계 전반에 사용할 수 있는 최신 사례들을 활용하여, 팀이 고민거리 없이 신속하게 서비스를 구축할 수 있도록 돕는 VueJS 보일러 플레이트입니다.',
11+
'Vuesion is a boilerplate that empowers product teams to build faster with modern best practices across engineering and design. It features a full-stack framework, comprehensive design system, robust testing, and seamless internationalization.',
2412
},
2513
},
2614
head: [
@@ -113,12 +101,12 @@ module.exports = {
113101
editLinkText: 'Edit this page on GitHub',
114102
nav: [
115103
{
116-
text: 'Interactive Demo',
117-
link: 'https://vuesion.herokuapp.com/',
104+
text: 'Storybook',
105+
link: 'https://vuesion.herokuapp.com/storybook/',
118106
},
119107
{
120-
text: 'Design System',
121-
link: 'https://vuesion.herokuapp.com/storybook',
108+
text: 'Figma UIKit',
109+
link: 'https://www.figma.com/community/file/1080868611324978249',
122110
},
123111
{
124112
text: 'Discord',
@@ -170,41 +158,30 @@ module.exports = {
170158
],
171159
'/en/v5/': [
172160
{
173-
title: 'General',
161+
title: 'Guide',
174162
collapsable: false,
175163
children: [
176-
'introduction',
177-
// 'FAQ'
164+
'guide/introduction',
165+
'guide/getting-started',
166+
'guide/concepts',
167+
'guide/development',
168+
'guide/design-system',
169+
'guide/community-and-support',
178170
],
179171
},
180172
{
181-
title: 'Getting started',
173+
title: 'Tutorials',
182174
collapsable: false,
183175
children: [
184-
'guide/install',
185-
// 'guide/run',
186-
// 'guide/test',
187-
// 'guide/cli',
188-
// 'guide/clean-up',
189-
// 'guide/contribute',
176+
'tutorials/layout-components',
177+
'tutorials/i18n',
178+
'tutorials/theming',
190179
],
191180
},
192-
// {
193-
// title: 'Deep dives',
194-
// collapsable: false,
195-
// children: [
196-
// 'deep_dives/build',
197-
// 'deep_dives/design-system',
198-
// 'deep_dives/i18n',
199-
// ['https://nuxtjs.org/docs/2.x/deployment/deploying-to-21yunbox', 'Deployment'],
200-
// 'deep_dives/update',
201-
// 'deep_dives/npm-scripts',
202-
// 'deep_dives/vuex',
203-
// ],
204-
// },
205181
],
206182
},
207183
},
208184
},
209185
},
186+
plugins: ['mermaidjs']
210187
};
8.03 KB
Loading
23.7 KB
Loading

.vuepress/public/apple-touch-icon.png

7.17 KB
Loading

.vuepress/public/favicon-16x16.png

536 Bytes
Loading

.vuepress/public/favicon-32x32.png

1.07 KB
Loading

.vuepress/public/favicon.ico

15 KB
Binary file not shown.

.vuepress/public/icon-128x128.png

-1.7 KB
Binary file not shown.

.vuepress/public/icon-144x144.png

-1.99 KB
Binary file not shown.

.vuepress/public/icon-152x152.png

-2.08 KB
Binary file not shown.

.vuepress/public/icon-192x192.png

-2.54 KB
Binary file not shown.

.vuepress/public/icon-384x384.png

-4.72 KB
Binary file not shown.

.vuepress/public/icon-512x512.png

-5.82 KB
Binary file not shown.

.vuepress/public/icon-72x72.png

-1.11 KB
Binary file not shown.

.vuepress/public/icon-96x96.png

-1.34 KB
Binary file not shown.

.vuepress/public/logo.png

-52.4 KB
Loading

.vuepress/public/manifest.json

+2-32
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,12 @@
99
"start_url": "/docs/en/",
1010
"icons": [
1111
{
12-
"src": "/icon-72x72.png",
13-
"sizes": "72x72",
14-
"type": "image/png"
15-
},
16-
{
17-
"src": "/icon-96x96.png",
18-
"sizes": "96x96",
19-
"type": "image/png"
20-
},
21-
{
22-
"src": "/icon-128x128.png",
23-
"sizes": "128x128",
24-
"type": "image/png"
25-
},
26-
{
27-
"src": "/icon-144x144.png",
28-
"sizes": "144x144",
29-
"type": "image/png"
30-
},
31-
{
32-
"src": "/icon-152x152.png",
33-
"sizes": "152x152",
34-
"type": "image/png"
35-
},
36-
{
37-
"src": "/icon-192x192.png",
12+
"src": "/android-chrome-192x192",
3813
"sizes": "192x192",
3914
"type": "image/png"
4015
},
4116
{
42-
"src": "/icon-384x384.png",
43-
"sizes": "384x384",
44-
"type": "image/png"
45-
},
46-
{
47-
"src": "/icon-512x512.png",
17+
"src": "/android-chrome-512x512",
4818
"sizes": "512x512",
4919
"type": "image/png"
5020
}

.vuepress/public/v5/vue-box.png

35.2 KB
Loading

.vuepress/public/v5/vue-columns.png

40.9 KB
Loading

.vuepress/public/v5/vue-inline.png

44.1 KB
Loading

.vuepress/public/v5/vue-stack.png

53.9 KB
Loading

.vuepress/styles/index.styl

+44-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
1-
@import url('https://fonts.googleapis.com/css?family=Inter:300,400,500,600,700,800|Lora:300,400,500,600,700,800&display=swap');
1+
@import url('https://fonts.bunny.net/css?family=Inter:400,600,900|Lora:400,600&display=swap');
22

33
html, body {
44
font-family: 'Inter', sans-serif;
55
font-weight: 400;
6-
background: #f1f3f5;
6+
background: #ffffff;
7+
color: #141518;
78
}
89

9-
h1, h2, h3, h4, h5, h6 {
10+
img, div[class*="language-"] {
11+
border-radius: 16px !important;
12+
}
13+
14+
h1 {
15+
font-family: 'Inter', sans-serif;
16+
font-weight: 900;
17+
}
18+
19+
h2, h3, h4, h5, h6 {
1020
font-family: 'Inter', sans-serif;
1121
font-weight: 600;
1222
}
@@ -15,7 +25,7 @@ h1, h2, h3, h4, h5, h6 {
1525
height: 56px !important;
1626
min-height: 56px !important;
1727
line-height: 1.5 !important;
18-
background: #f1f3f5;
28+
background: #ffffff;
1929
}
2030

2131
.navbar .logo {
@@ -27,14 +37,41 @@ h1, h2, h3, h4, h5, h6 {
2737

2838
.sidebar {
2939
top: 56px;
30-
background: #f1f3f5;
40+
background: #ffffff;
3141
}
3242

3343
.links, .search-box input {
34-
background-color: #f1f3f5 !important;
44+
background-color: #ffffff !important;
3545
}
3646

3747
code {
38-
background-color: #282c2e !important;
48+
background-color: #272a31 !important;
3949
color: #fff !important;
4050
}
51+
52+
blockquote, .description {
53+
color: #4c535f !important;
54+
}
55+
56+
.mermaid-diagram .node circle {
57+
fill: #663CCB !important;
58+
stroke: #663CCB !important;
59+
stroke-width: 2px !important;
60+
}
61+
62+
.mermaid-diagram .node .nodeLabel {
63+
color: #fff !important;
64+
font-family: 'Inter', sans-serif;
65+
font-weight: 600;
66+
font-size: 14px;
67+
}
68+
.mermaid-diagram .edgeLabels {
69+
transform: translateY(-10px);
70+
}
71+
.mermaid-diagram .edgeLabels > .edgeLabel span {
72+
color: #3f444e !important;
73+
background-color: transparent !important;
74+
font-family: 'Inter', sans-serif;
75+
font-weight: 400;
76+
font-size: 14px;
77+
}

.vuepress/styles/palette.styl

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// colors
2-
$accentColor = #cf508d
3-
$textColor = #313437
4-
$borderColor = #d7dbdf
5-
$codeBgColor = #282c34
2+
$accentColor = #663ccb
3+
$textColor = #141518
4+
$borderColor = #eff0f2
5+
$codeBgColor = #272a31
66
$arrowBgColor = #cf508d
77
$badgeTipColor = #30a46c
88
$badgeWarningColor = #dba70c

en/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Versions
2+
[v4 Docs](./v4)
3+
4+
[v5 Docs](./v5)
5+

en/v5/FAQ.md

-21
This file was deleted.

en/v5/README.md

+2-23
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,6 @@
22
home: true
33
heroImage: /logo.png
44
actionText: Get Started →
5-
actionLink: ./introduction
6-
features:
7-
- title: Quick scaffolding
8-
details: Create components, pages, vuex-modules, stories, interfaces, fixtures - and their tests - right from the CLI
9-
- title: Server-side-rendering
10-
details: Use server-side-rendering, create a single-page-app or generate static HTML powered by Nuxt.js
11-
- title: Industry-standard i18n support
12-
details: Scalable apps need to support multiple languages, easily add and support multiple languages
13-
- title: Progressive-Web-App
14-
details: Offline-first support with service-workers and a lighthouse score as high as possible
15-
- title: Customizable Design System
16-
details: Includes a blueprint for a 100% customizable, themeable Design System with 35+ components
17-
- title: Storybook
18-
details: Allows interactive development, testing and sharing of UI components in various property states
19-
- title: Figma UIKit
20-
details: The included Figma design system file includes the basics and all components of the Vuesion design system and it's perfectly in sync with storybook
21-
- title: GraphQL
22-
details: includes a blueprint how to use vue-apollo with the auth-module, axios-module (re-authentication) and the composition-api
23-
- title: DX, Code quality and maintenance
24-
details: TypeScript, Eslint, commit message lint, prettier and husky set up will help you to keep a high code quality
25-
26-
27-
footer: MIT Licensed | Copyright © 2018 - present Johannes Werner
5+
actionLink: ./guide/introduction
6+
footer: MIT Licensed | Copyright © 2018 - present Werner-Most Ideen GmbH
287
---

en/v5/deep_dives/build.md

-38
This file was deleted.

0 commit comments

Comments
 (0)