Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Init the Chinese translation and import existing files from a legacy repo #19

Merged
merged 49 commits into from
Nov 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
ce3f418
translation: start the zh version from legacy repo (docs-next-zh-cn)
Jinjiang Nov 3, 2022
a289ca8
translation: init locales config and create missing md file
zhousg Nov 4, 2022
d04973a
translation: add todos
zhousg Nov 4, 2022
bf1aa8c
translation: add Overview content
zhousg Nov 5, 2022
5699783
translation: add New Framework-level Recommendations about Build Tool…
chaichai-fe Nov 5, 2022
c21ae04
translation: add New Framework-level Recommendations about Vue Router
chaichai-fe Nov 5, 2022
444face
translation: add New Framework-level Recommendations about State Mana…
chaichai-fe Nov 5, 2022
b654b1d
translation: add how to use the Vuex 4.0 to support Vue3
chaichai-fe Nov 5, 2022
9cd56d1
translation: add New Framework-level Recommendations about IDE Suppor…
chaichai-fe Nov 5, 2022
7eb6763
translation: add New Framework-level Recommendations about Typescript…
chaichai-fe Nov 5, 2022
a748090
Merge pull request #20 from zhousg/translation-zh
Jinjiang Nov 5, 2022
aba40c8
translation: add some warnings for unfinished Chinese docs
Jinjiang Nov 5, 2022
0b3b15a
translation: update vue-tsc link
zhousg Nov 5, 2022
327553a
translation: update vue-tsc link
zhousg Nov 5, 2022
51fdc7e
fix: VNode Lifecycle Event
Megasu Nov 5, 2022
8c4ba9b
Merge branch 'translation-zh' of https://github.com/zhousg/v3-migrati…
Megasu Nov 5, 2022
2731411
update jsx repo
Megasu Nov 5, 2022
d524075
Expose configureCompat types
Megasu Nov 5, 2022
e1c60db
update vue-router vuex url
Megasu Nov 5, 2022
ce07656
translation: add Breaking Changes about Global API and Template Direc…
chaichai-fe Nov 5, 2022
b4d89ba
translation: add Breaking Changes about Components
chaichai-fe Nov 5, 2022
c3aa503
translation: update dead links end components
zhousg Nov 5, 2022
b679407
Merge branch 'translation-zh' of github.com:zhousg/v3-migration-guide…
zhousg Nov 5, 2022
7e796d9
translation: Breaking Changes
Megasu Nov 5, 2022
123ab63
translation: update all dead links
Megasu Nov 5, 2022
67f89ae
translation: update zh index links
Megasu Nov 5, 2022
8b13111
translation: update migration-badges component
zhousg Nov 5, 2022
0e7cf9c
Merge branch 'translation-zh' of github.com:zhousg/v3-migration-guide…
zhousg Nov 5, 2022
25f3e9d
translation: update vue-tsc link
zhousg Nov 5, 2022
4f37dd4
translation: update vue-tsc link
zhousg Nov 5, 2022
6f4e60c
translation: update dead links end components
zhousg Nov 5, 2022
69a8ffe
fix: VNode Lifecycle Event
Megasu Nov 5, 2022
e356275
update jsx repo
Megasu Nov 5, 2022
7f5936a
Expose configureCompat types
Megasu Nov 5, 2022
8386b0b
update vue-router vuex url
Megasu Nov 5, 2022
5acbc97
translation: add Breaking Changes about Global API and Template Direc…
chaichai-fe Nov 5, 2022
1976ca6
translation: add Breaking Changes about Components
chaichai-fe Nov 5, 2022
b0a23ec
translation: update migration-badges component
zhousg Nov 5, 2022
28860f2
translation: Breaking Changes
Megasu Nov 5, 2022
16e08dc
translation: update all dead links
Megasu Nov 5, 2022
ba6de4f
translation: update zh index links
Megasu Nov 5, 2022
25309b0
Merge branch 'translation-zh' of github.com:zhousg/v3-migration-guide…
zhousg Nov 5, 2022
08d0668
translation: reset en md
zhousg Nov 6, 2022
231f2e7
translation: reset en md
zhousg Nov 6, 2022
adc693a
translation: updated relative link
zhousg Nov 6, 2022
9bd70fb
translation: updated badges locales
zhousg Nov 6, 2022
8bfcf62
Merge pull request #22 from zhousg/translation-zh
Jinjiang Nov 6, 2022
0336fa9
translation: fix broken links in zh
Jinjiang Nov 6, 2022
97ccd22
docs(zh): avoid internal weak map key error
Jinjiang Nov 6, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 14 additions & 150 deletions .vitepress/config.js
Original file line number Diff line number Diff line change
@@ -1,156 +1,20 @@
import locales from "./locales"

/**
* @type {import('vitepress').UserConfig}
*/
export default {
title: 'Vue 3 Migration Guide',
description: 'Guide on migrating from Vue 2 to Vue 3',
srcDir: 'src',
locales: locales.vitepressConfig,


themeConfig: {
nav: [{ text: 'Vue 3 Docs', link: 'https://vuejs.org' }],

sidebar: [
{
text: 'Guide',
items: [
{ text: 'Overview', link: '/' },
{ text: 'New Recommendations', link: '/recommendations' },
{ text: 'Migration Build', link: '/migration-build' },
{
text: 'Breaking Changes',
link: '/breaking-changes/'
}
]
},
{
text: 'Global API',
items: [
{
text: 'Global API Application Instance',
link: '/breaking-changes/global-api'
},
{
text: 'Global API Treeshaking',
link: '/breaking-changes/global-api-treeshaking'
}
]
},
{
text: 'Template Directives',
items: [
{ text: 'v-model', link: '/breaking-changes/v-model' },
{
text: 'key Usage Change',
link: '/breaking-changes/key-attribute'
},
{
text: 'v-if vs. v-for Precedence',
link: '/breaking-changes/v-if-v-for'
},
{ text: 'v-bind Merge Behavior', link: '/breaking-changes/v-bind' },
{
text: 'v-on.native modifier removed',
link: '/breaking-changes/v-on-native-modifier-removed'
}
]
},
{
text: 'Components',
items: [
{
text: 'Functional Components',
link: '/breaking-changes/functional-components'
},
{
text: 'Async Components',
link: '/breaking-changes/async-components'
},
{ text: 'emits Option', link: '/breaking-changes/emits-option' }
]
},
{
text: 'Render Function',
items: [
{
text: 'Render Function API',
link: '/breaking-changes/render-function-api'
},
{
text: 'Slots Unification',
link: '/breaking-changes/slots-unification'
},
{
text: '$listeners merged into $attrs',
link: '/breaking-changes/listeners-removed'
},
{
text: '$attrs includes class & style',
link: '/breaking-changes/attrs-includes-class-style'
}
]
},
{
text: 'Custom Elements',
items: [
{
text: 'Custom Elements Interop Changes',
link: '/breaking-changes/custom-elements-interop'
}
]
},
{
text: 'Removed APIs',
items: [
{
text: 'v-on keyCode Modifiers',
link: '/breaking-changes/keycode-modifiers'
},
{ text: 'Events API', link: '/breaking-changes/events-api' },
{ text: 'Filters', link: '/breaking-changes/filters' },
{
text: 'inline-template',
link: '/breaking-changes/inline-template-attribute'
},
{ text: '$children', link: '/breaking-changes/children' },
{ text: 'propsData option', link: '/breaking-changes/props-data' }
]
},
{
text: 'Other Minor Changes',
items: [
{
text: 'Attribute Coercion Behavior',
link: '/breaking-changes/attribute-coercion'
},
{
text: 'Custom Directives',
link: '/breaking-changes/custom-directives'
},
{ text: 'Data Option', link: '/breaking-changes/data-option' },
{
text: 'Mount API changes',
link: '/breaking-changes/mount-changes'
},
{
text: 'Props Default Function this Access',
link: '/breaking-changes/props-default-this'
},
{
text: 'Transition Class Change',
link: '/breaking-changes/transition'
},
{
text: 'Transition as Root',
link: '/breaking-changes/transition-as-root'
},
{
text: 'Transition Group Root Element',
link: '/breaking-changes/transition-group'
},
{
text: 'VNode lifecycle events',
link: '/breaking-changes/vnode-lifecycle-events'
},
{ text: 'Watch on Arrays', link: '/breaking-changes/watch' }
]
}
]
localeLinks: {
items: [
{text: 'English', link: '/'},
{text: '中文简体 (未完成)', link: '/zh/'}
]
},
locales: locales.themeConfig
}
}
159 changes: 159 additions & 0 deletions .vitepress/locales/en.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
export default {
vitepressConfig: {
title: 'Vue 3 Migration Guide',
description: 'Guide on migrating from Vue 2 to Vue 3',
lang: 'en-US'
},
themeConfig: {
nav: [
{ text: 'Vue 3 Docs', link: 'https://vuejs.org' },
],

sidebar: [
{
text: 'Guide',
items: [
{ text: 'Overview', link: '/' },
{ text: 'New Recommendations', link: '/recommendations' },
{ text: 'Migration Build', link: '/migration-build' },
{
text: 'Breaking Changes',
link: '/breaking-changes/'
}
]
},
{
text: 'Global API',
items: [
{
text: 'Global API Application Instance',
link: '/breaking-changes/global-api'
},
{
text: 'Global API Treeshaking',
link: '/breaking-changes/global-api-treeshaking'
}
]
},
{
text: 'Template Directives',
items: [
{ text: 'v-model', link: '/breaking-changes/v-model' },
{
text: 'key Usage Change',
link: '/breaking-changes/key-attribute'
},
{
text: 'v-if vs. v-for Precedence',
link: '/breaking-changes/v-if-v-for'
},
{ text: 'v-bind Merge Behavior', link: '/breaking-changes/v-bind' },
{
text: 'v-on.native modifier removed',
link: '/breaking-changes/v-on-native-modifier-removed'
}
]
},
{
text: 'Components',
items: [
{
text: 'Functional Components',
link: '/breaking-changes/functional-components'
},
{
text: 'Async Components',
link: '/breaking-changes/async-components'
},
{ text: 'emits Option', link: '/breaking-changes/emits-option' }
]
},
{
text: 'Render Function',
items: [
{
text: 'Render Function API',
link: '/breaking-changes/render-function-api'
},
{
text: 'Slots Unification',
link: '/breaking-changes/slots-unification'
},
{
text: '$listeners merged into $attrs',
link: '/breaking-changes/listeners-removed'
},
{
text: '$attrs includes class & style',
link: '/breaking-changes/attrs-includes-class-style'
}
]
},
{
text: 'Custom Elements',
items: [
{
text: 'Custom Elements Interop Changes',
link: '/breaking-changes/custom-elements-interop'
}
]
},
{
text: 'Removed APIs',
items: [
{
text: 'v-on keyCode Modifiers',
link: '/breaking-changes/keycode-modifiers'
},
{ text: 'Events API', link: '/breaking-changes/events-api' },
{ text: 'Filters', link: '/breaking-changes/filters' },
{
text: 'inline-template',
link: '/breaking-changes/inline-template-attribute'
},
{ text: '$children', link: '/breaking-changes/children' },
{ text: 'propsData option', link: '/breaking-changes/props-data' }
]
},
{
text: 'Other Minor Changes',
items: [
{
text: 'Attribute Coercion Behavior',
link: '/breaking-changes/attribute-coercion'
},
{
text: 'Custom Directives',
link: '/breaking-changes/custom-directives'
},
{ text: 'Data Option', link: '/breaking-changes/data-option' },
{
text: 'Mount API changes',
link: '/breaking-changes/mount-changes'
},
{
text: 'Props Default Function this Access',
link: '/breaking-changes/props-default-this'
},
{
text: 'Transition Class Change',
link: '/breaking-changes/transition'
},
{
text: 'Transition as Root',
link: '/breaking-changes/transition-as-root'
},
{
text: 'Transition Group Root Element',
link: '/breaking-changes/transition-group'
},
{
text: 'VNode lifecycle events',
link: '/breaking-changes/vnode-lifecycle-events'
},
{ text: 'Watch on Arrays', link: '/breaking-changes/watch' }
]
}
]
}
}
13 changes: 13 additions & 0 deletions .vitepress/locales/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import en from './en'
import zh from './zh'

export default {
vitepressConfig: {
'/': en.vitepressConfig,
'/zh/': zh.vitepressConfig
},
themeConfig: {
'/': en.themeConfig,
'/zh/': zh.themeConfig
}
}
Loading