Skip to content

Commit

Permalink
feat(v5): add initial docs
Browse files Browse the repository at this point in the history
  • Loading branch information
devCrossNet committed Sep 9, 2023
1 parent 263ec94 commit 2c301a9
Show file tree
Hide file tree
Showing 64 changed files with 3,477 additions and 17,248 deletions.
153 changes: 24 additions & 129 deletions .vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module.exports = {
head: [
['script', {}, `(function customScript() {
window.addEventListener('load', () => {
var version = window.location.pathname.includes('v4') ? 'v4' : 'v3';
var version = window.location.pathname.includes('v5') ? 'v5' : 'v4';
var homeLink = document.querySelector('.home-link');
if (homeLink) {
Expand Down Expand Up @@ -127,43 +127,12 @@ module.exports = {
{
text: 'Versions',
items: [
{text: 'v3', link: '/en/v3/'},
{text: 'v4', link: '/en/v4/'}
{text: 'v4', link: '/en/v4/'},
{text: 'v5', link: '/en/v5/'}
]
}
],
sidebar: {
'/en/v3/': [
{
title: 'Getting started',
collapsable: false,
children: [
'FAQ',
'guide/install',
'guide/run',
'guide/test',
'guide/i18n',
'guide/cli',
'guide/clean-up',
'guide/vuex',
'guide/build',
'guide/config',
'guide/contribute',
'guide/update',
'guide/deployment',
],
},
{
title: 'Tutorials',
collapsable: false,
children: ['tutorials/redirects', 'tutorials/prefetch-and-state-transfer', 'tutorials/third-party', 'tutorials/deploy-with-firebase'],
},
{
title: 'Docs',
collapsable: false,
children: ['docs/style-guide', 'docs/pwa', 'docs/npm-scripts'],
},
],
'/en/v4/': [
{
title: 'General',
Expand Down Expand Up @@ -199,117 +168,43 @@ module.exports = {
],
},
],
},
},
'/ru/': {
label: 'Русский',
editLinkText: 'Редактировать эту страницу на GitHub',
nav: [
{
text: 'Интерактивное Демо',
link: 'https://vuesion.herokuapp.com/',
},
{
text: 'Дизайн-система',
link: 'https://vuesion.herokuapp.com/storybook',
},
{
text: 'Discord',
link: 'https://discord.gg/59x5cg2',
},
{
text: 'Версии',
items: [
{text: 'v4', link: '/en/v4/'}
]
}
],
sidebar: {
'/ru/v4/': [
'/en/v5/': [
{
title: 'General',
collapsable: false,
children: [
'introduction',
'FAQ'
// 'FAQ'
],
},
{
title: 'Начало работы',
title: 'Getting started',
collapsable: false,
children: [
'guide/install',
'guide/run',
'guide/test',
'guide/i18n',
'guide/cli',
'guide/clean-up',
'guide/vuex',
'guide/build',
'guide/contribute',
'guide/update',
['https://nuxtjs.org/docs/2.x/deployment/deploying-to-21yunbox', 'Deployment'],
'guide/npm-scripts',
// 'guide/run',
// 'guide/test',
// 'guide/cli',
// 'guide/clean-up',
// 'guide/contribute',
],
},
// {
// title: 'Deep dives',
// collapsable: false,
// children: [
// 'deep_dives/build',
// 'deep_dives/design-system',
// 'deep_dives/i18n',
// ['https://nuxtjs.org/docs/2.x/deployment/deploying-to-21yunbox', 'Deployment'],
// 'deep_dives/update',
// 'deep_dives/npm-scripts',
// 'deep_dives/vuex',
// ],
// },
],
},
},
'/ko/': {
label: '한국어',
editLinkText: 'GitHub에서 현재 페이지 수정하기',
nav: [
{
text: '인터렉티브 데모',
link: 'https://vuesion.herokuapp.com/',
},
{
text: '디자인 시스템',
link: 'https://vuesion.herokuapp.com/storybook',
},
{
text: '디스코드',
link: 'https://discord.gg/59x5cg2',
},
{
text: '버전',
items: [
{text: 'v3 (영문)', link: '/en/v3/'},
{text: 'v4', link: '/ko/v4/'}
]
}
],
sidebar: {
'/ko/v4/': [
{
title: '일반',
collapsable: false,
children: [
'introduction',
'FAQ'
],
},
{
title: '시작하기',
collapsable: false,
children: [
'guide/install',
'guide/run',
'guide/test',
'guide/i18n',
'guide/cli',
'guide/clean-up',
'guide/vuex',
'guide/build',
'guide/contribute',
'guide/update',
['https://nuxtjs.org/docs/2.x/deployment/deploying-to-21yunbox', '배포하기'],
'guide/npm-scripts',
],
},
],
},
}
},
},
};
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@


# Links
[v3 Docs](https://vuesion.github.io/docs/en/v3/)

[v4 Docs](https://vuesion.github.io/docs/en/v4/)

[v5 Docs](https://vuesion.github.io/docs/en/v5/)

# Development

- clone repo
- run `npm install`
- run `npm run dev`
- open [http://localhost:8080/docs/en/v4/](http://localhost:8080/docs/en/v4/)
- open [http://localhost:8080/docs/en/v5/](http://localhost:8080/docs/en/v4/)

# Contribute

Expand Down
62 changes: 0 additions & 62 deletions en/v3/FAQ.md

This file was deleted.

32 changes: 0 additions & 32 deletions en/v3/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions en/v3/docs/pwa.md

This file was deleted.

Loading

0 comments on commit 2c301a9

Please sign in to comment.