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

translation: init locales config and create missing md file #20

Merged
merged 9 commits into from
Nov 5, 2022
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