From f6c879d95f86a674b2bacb5a9d3cce1ee891053c Mon Sep 17 00:00:00 2001 From: liangzhensheng <1250564179@qq.com> Date: Sun, 29 Jan 2023 13:06:20 +0800 Subject: [PATCH 01/11] docs: add zh-cn guide --- docs/.vitepress/locales/zh-cn.ts | 13 +++++++++++++ docs/zh-CN/guide/bundler-integration.md | 14 ++++++------- docs/zh-CN/guide/configurations.md | 8 ++++---- docs/zh-CN/guide/getting-started.md | 26 ++++++++++++------------- docs/zh-CN/guide/nuxt-integration.md | 10 +++++----- docs/zh-CN/macros/index.md | 24 +++++++++++------------ 6 files changed, 54 insertions(+), 41 deletions(-) diff --git a/docs/.vitepress/locales/zh-cn.ts b/docs/.vitepress/locales/zh-cn.ts index 3ec9d7efd..f1955e7d0 100644 --- a/docs/.vitepress/locales/zh-cn.ts +++ b/docs/.vitepress/locales/zh-cn.ts @@ -12,6 +12,19 @@ export const nav: DefaultTheme.NavItem[] = [ export const sidebar = common.sidebar('zh-CN') +const sidebarTitle: string[] = ['指南', '宏', '特性'] +const sidebarItem: string[][] = [ + ['入门', '打包器整合', 'Nuxt 整合', '配置'], + [''], + [''], +] +sidebar.forEach((bar, i) => { + bar.text = sidebarTitle[i] + bar.items.forEach((item, j) => { + if (sidebarItem[i][j]) item.text = sidebarItem[i][j] + }) +}) + export const themeConfig: DefaultTheme.Config = { ...common.themeConfig, diff --git a/docs/zh-CN/guide/bundler-integration.md b/docs/zh-CN/guide/bundler-integration.md index 1a9b553a7..b0b5a16e0 100644 --- a/docs/zh-CN/guide/bundler-integration.md +++ b/docs/zh-CN/guide/bundler-integration.md @@ -1,6 +1,6 @@ -# Bundler Integration +# 打包器整合 -### Installation +### 安装 ::: code-group @@ -96,7 +96,7 @@ module.exports = defineConfig({ ::: -## TypeScript Support +## TypeScript 支持 ::: code-group @@ -122,9 +122,9 @@ module.exports = defineConfig({ ::: -## Volar Support +## Volar 支持 -For detailed configuration, please refer to the description of the specific macro. +详细配置请参考每个宏的具体说明。 ```bash npm i -D @vue-macros/volar @@ -147,6 +147,6 @@ npm i -D @vue-macros/volar } ``` -:tada: Congratulations! You have successfully set up `unplugin-vue-macros`. +:tada: 祝贺你! 你已经成功设置完成 `unplugin-vue-macros`. -To learn more about the macros, please visit [All Macros](/macros/) :laughing:. +想要了解有关宏的更多信息, 请访问 [全部宏](/zh-CN/macros/) :laughing:. diff --git a/docs/zh-CN/guide/configurations.md b/docs/zh-CN/guide/configurations.md index ac601af36..1a1f14614 100644 --- a/docs/zh-CN/guide/configurations.md +++ b/docs/zh-CN/guide/configurations.md @@ -1,8 +1,8 @@ -# Configurations +# 配置 -## Plugin Options +## 插件选项 -All features are enabled by default, you can disable them by setting the option to `false`. +所有功能将会被默认开启, 您可以将选项设置为 `false` 来禁用它们。 ```ts VueMacros({ @@ -37,4 +37,4 @@ VueMacros({ }) ``` -See the features page for options for each feature. +有关每个功能的选项,请参考功能页面。 diff --git a/docs/zh-CN/guide/getting-started.md b/docs/zh-CN/guide/getting-started.md index 6db62e001..cf9c7e767 100644 --- a/docs/zh-CN/guide/getting-started.md +++ b/docs/zh-CN/guide/getting-started.md @@ -1,29 +1,29 @@ -# Getting Started +# 入门 -Vue Macros is a library that implements proposals or ideas that have not been officially implemented by Vue. That means it will explore and extend more features and syntax sugar to Vue. +Vue Macros 是一个库,用于实现尚未被 Vue 正式实现的提案或想法。这意味着它将探索和扩展 Vue 的更多功能和语法糖。 -We assume you are already familiar with the basic usages of Vue before you continue. +在继续之前,我们假设您已经熟悉 Vue 的基本用法。 -## Requirements +## 要求 - Vue >= 2.7 or Vue >= 3.0. - - Some features need Vue >= 3.2.25. -- VSCode with [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) extension. - - ❌ WebStorm is not supported. + - 某些功能需要 Vue >= 3.2.25 +- VSCode 安装了 [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) 扩展. + - ❌ 不支持 WebStorm -## Demos +## 示例 - [Vite + Vue 3](https://github.com/sxzz/unplugin-vue-macros/tree/main/playground/vue3) - [Vite + Vue 2](https://github.com/sxzz/unplugin-vue-macros/tree/main/playground/vue2) - [Nuxt 3 + Vue 3](https://github.com/vue-macros/nuxt) - [Vue CLI + Vue 2](https://github.com/vue-macros/vue2-vue-cli) -🌟 More demos are welcome! +🌟 欢迎提供更多示例! -## Nuxt Integration +## Nuxt 整合 -If you're using [Nuxt 3](https://nuxt.com/), read the [Nuxt Integration](./nuxt-integration.md). +如果您使用的是 [Nuxt 3](https://nuxt.com/), 请阅读 [Nuxt 整合](./nuxt-integration.md). -## Bundler Integrations +## 打包器整合 -If you're using [Vite](https://vitejs.dev/), [Rollup](https://rollupjs.org/), [esbuild](https://esbuild.github.io/), or [Webpack](https://webpack.js.org/), read the [Bundler Integration](./bundler-integration.md). +如果您使用的是 [Vite](https://vitejs.dev/), [Rollup](https://rollupjs.org/), [esbuild](https://esbuild.github.io/), 或 [Webpack](https://webpack.js.org/)这一类的打包工具, 请阅读 [打包器整合](./bundler-integration.md). diff --git a/docs/zh-CN/guide/nuxt-integration.md b/docs/zh-CN/guide/nuxt-integration.md index 4e60bf0c3..a44d75af5 100644 --- a/docs/zh-CN/guide/nuxt-integration.md +++ b/docs/zh-CN/guide/nuxt-integration.md @@ -1,6 +1,6 @@ -# Nuxt Integration +# Nuxt 整合 -### Installation +### 安装 ::: code-group @@ -18,7 +18,7 @@ pnpm add -D @vue-macros/nuxt ::: -## Configuration +## 配置 ```ts // nuxt.config.ts @@ -33,6 +33,6 @@ export default { } ``` -:tada: Congratulations! That's all. +:tada: 祝贺你! 成功完成了 Nuxt 整合. -To learn more about the macros, please visit [All Macros](/macros/) :laughing:. +想要了解有关宏的更多信息, 请访问 [全部宏](/zh-CN/macros/) :laughing:. diff --git a/docs/zh-CN/macros/index.md b/docs/zh-CN/macros/index.md index 5a69f305b..7cc6ca97c 100644 --- a/docs/zh-CN/macros/index.md +++ b/docs/zh-CN/macros/index.md @@ -1,15 +1,15 @@ -# Usage +# 用法 -List of all available macros. +所有可用宏的列表。 -Please make sure `unplugin-vue-macros` is set up correctly. If you haven't yet, read [Getting Started](/guide/getting-started) first. +请确保 `unplugin-vue-macros` 设置正确。如果您还没有设置, 请先阅读 [入门](/zh-CN/guide/getting-started) -- [defineOptions](/macros/define-options) -- [defineModel](/macros/define-model) -- [defineProps](/macros/define-props) -- [defineSlots](/macros/define-slots) -- [defineRender](/macros/define-render) -- [shortEmits](/macros/short-emits) -- [shortVmodel](/macros/short-vmodel) -- [setupComponent](/macros/setup-component) Experimental -- [setupSFC](/macros/setup-sfc) Experimental +- [defineOptions](/zh-CN/macros/define-options) +- [defineModel](/zh-CN/macros/define-model) +- [defineProps](/zh-CN/macros/define-props) +- [defineSlots](/zh-CN/macros/define-slots) +- [defineRender](/zh-CN/macros/define-render) +- [shortEmits](/zh-CN/macros/short-emits) +- [shortVmodel](/zh-CN/macros/short-vmodel) +- [setupComponent](/zh-CN/macros/setup-component) 实验性 +- [setupSFC](/zh-CN/macros/setup-sfc) 实验性 From d597a684096ee79f6e5b4d886df9b6ae8052c6ce Mon Sep 17 00:00:00 2001 From: liangzhensheng <1250564179@qq.com> Date: Sun, 29 Jan 2023 15:29:59 +0800 Subject: [PATCH 02/11] docs: add zh-cn macros --- docs/.vitepress/locales/zh-cn.ts | 2 +- docs/zh-CN/guide/bundler-integration.md | 4 ++-- docs/zh-CN/guide/configurations.md | 2 +- docs/zh-CN/guide/getting-started.md | 8 +++---- docs/zh-CN/guide/nuxt-integration.md | 4 ++-- docs/zh-CN/macros/define-model.md | 22 +++++++++--------- docs/zh-CN/macros/define-options.md | 18 +++++++-------- docs/zh-CN/macros/define-props-refs.md | 10 ++++----- docs/zh-CN/macros/define-props.md | 14 ++++++------ docs/zh-CN/macros/define-render.md | 8 +++---- docs/zh-CN/macros/define-slots.md | 22 +++++++++--------- docs/zh-CN/macros/setup-component.md | 24 +++++++++++--------- docs/zh-CN/macros/setup-sfc.md | 20 +++++++++-------- docs/zh-CN/macros/short-emits.md | 10 ++++----- docs/zh-CN/macros/short-vmodel.md | 30 ++++++++++++------------- 15 files changed, 101 insertions(+), 97 deletions(-) diff --git a/docs/.vitepress/locales/zh-cn.ts b/docs/.vitepress/locales/zh-cn.ts index f1955e7d0..e56e6e15c 100644 --- a/docs/.vitepress/locales/zh-cn.ts +++ b/docs/.vitepress/locales/zh-cn.ts @@ -15,7 +15,7 @@ export const sidebar = common.sidebar('zh-CN') const sidebarTitle: string[] = ['指南', '宏', '特性'] const sidebarItem: string[][] = [ ['入门', '打包器整合', 'Nuxt 整合', '配置'], - [''], + ['全部宏'], [''], ] sidebar.forEach((bar, i) => { diff --git a/docs/zh-CN/guide/bundler-integration.md b/docs/zh-CN/guide/bundler-integration.md index b0b5a16e0..747d9b9da 100644 --- a/docs/zh-CN/guide/bundler-integration.md +++ b/docs/zh-CN/guide/bundler-integration.md @@ -147,6 +147,6 @@ npm i -D @vue-macros/volar } ``` -:tada: 祝贺你! 你已经成功设置完成 `unplugin-vue-macros`. +:tada: 祝贺你! 你已经成功设置完成 `unplugin-vue-macros`。 -想要了解有关宏的更多信息, 请访问 [全部宏](/zh-CN/macros/) :laughing:. +想要了解有关宏的更多信息, 请访问 [全部宏](/zh-CN/macros/) :laughing:。 diff --git a/docs/zh-CN/guide/configurations.md b/docs/zh-CN/guide/configurations.md index 1a1f14614..f626beb76 100644 --- a/docs/zh-CN/guide/configurations.md +++ b/docs/zh-CN/guide/configurations.md @@ -2,7 +2,7 @@ ## 插件选项 -所有功能将会被默认开启, 您可以将选项设置为 `false` 来禁用它们。 +所有功能将会被默认开启,您可以将选项设置为 `false` 来禁用它们。 ```ts VueMacros({ diff --git a/docs/zh-CN/guide/getting-started.md b/docs/zh-CN/guide/getting-started.md index cf9c7e767..5ccfdccfa 100644 --- a/docs/zh-CN/guide/getting-started.md +++ b/docs/zh-CN/guide/getting-started.md @@ -6,9 +6,9 @@ Vue Macros 是一个库,用于实现尚未被 Vue 正式实现的提案或想 ## 要求 -- Vue >= 2.7 or Vue >= 3.0. +- Vue >= 2.7 or Vue >= 3.0 - 某些功能需要 Vue >= 3.2.25 -- VSCode 安装了 [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) 扩展. +- VSCode 安装了 [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) 扩展 - ❌ 不支持 WebStorm ## 示例 @@ -22,8 +22,8 @@ Vue Macros 是一个库,用于实现尚未被 Vue 正式实现的提案或想 ## Nuxt 整合 -如果您使用的是 [Nuxt 3](https://nuxt.com/), 请阅读 [Nuxt 整合](./nuxt-integration.md). +如果您使用的是 [Nuxt 3](https://nuxt.com/),请阅读 [Nuxt 整合](./nuxt-integration.md)。 ## 打包器整合 -如果您使用的是 [Vite](https://vitejs.dev/), [Rollup](https://rollupjs.org/), [esbuild](https://esbuild.github.io/), 或 [Webpack](https://webpack.js.org/)这一类的打包工具, 请阅读 [打包器整合](./bundler-integration.md). +如果您使用的是 [Vite](https://vitejs.dev/),[Rollup](https://rollupjs.org/),[esbuild](https://esbuild.github.io/),或 [Webpack](https://webpack.js.org/)这一类的打包工具,请阅读 [打包器整合](./bundler-integration.md)。 diff --git a/docs/zh-CN/guide/nuxt-integration.md b/docs/zh-CN/guide/nuxt-integration.md index a44d75af5..1f02bc972 100644 --- a/docs/zh-CN/guide/nuxt-integration.md +++ b/docs/zh-CN/guide/nuxt-integration.md @@ -33,6 +33,6 @@ export default { } ``` -:tada: 祝贺你! 成功完成了 Nuxt 整合. +:tada: 祝贺你! 成功完成了 Nuxt 整合。 -想要了解有关宏的更多信息, 请访问 [全部宏](/zh-CN/macros/) :laughing:. +想要了解有关宏的更多信息, 请访问 [全部宏](/zh-CN/macros/) :laughing:。 diff --git a/docs/zh-CN/macros/define-model.md b/docs/zh-CN/macros/define-model.md index bd1f400cd..4103ec66b 100644 --- a/docs/zh-CN/macros/define-model.md +++ b/docs/zh-CN/macros/define-model.md @@ -1,17 +1,17 @@ # defineModel -Stability: stable +稳定性: 稳定 -Declaring and mutate `v-model` props as the same as normal variable using the `defineModel`. +使用 `defineModel`声明和改变 `v-model` 的 props 和普通变量相同。 -| Features | Supported | +| 特性 | 支持 | | :----------: | :----------------: | | Vue 3 | :white_check_mark: | | Nuxt 3 | :white_check_mark: | | Vue 2 | :white_check_mark: | | Volar Plugin | :white_check_mark: | -## Options +## 选项 ```ts VueMacros({ @@ -26,9 +26,9 @@ VueMacros({ }) ``` -## Usage +## 用法 -Requires [`@vueuse/core`](https://www.npmjs.com/package/@vueuse/core), install it by yourself before using. +需要 [`@vueuse/core`](https://www.npmjs.com/package/@vueuse/core),在使用之前请自行安装 ```vue ``` -::: warning ❌ Object declaring is not supported. +::: warning ❌ 不支持对象声明 ```vue ``` -## Volar Configuration +## Volar 配置 ```jsonc {6} // tsconfig.json diff --git a/docs/zh-CN/macros/define-props.md b/docs/zh-CN/macros/define-props.md index 610f63fc3..52434738d 100644 --- a/docs/zh-CN/macros/define-props.md +++ b/docs/zh-CN/macros/define-props.md @@ -1,12 +1,12 @@ # defineProps -Stability: stable +稳定性: 稳定 -Correct types of destructured props using `$defineProps`. +使用 `$defineProps` 正确的解构 props 类型 -See also [Vue issue](https://github.com/vuejs/core/issues/6876), [Reactivity Transform RFC](https://github.com/vuejs/rfcs/blob/reactivity-transform/active-rfcs/0000-reactivity-transform.md#defineprops-destructure-details). +参见 [Vue issue](https://github.com/vuejs/core/issues/6876), [Reactivity Transform RFC](https://github.com/vuejs/rfcs/blob/reactivity-transform/active-rfcs/0000-reactivity-transform.md#defineprops-destructure-details). -| Features | Supported | +| 特性 | 支持 | | :-----------------------: | :----------------: | | Vue 3 | :white_check_mark: | | Nuxt 3 | :white_check_mark: | @@ -15,11 +15,11 @@ See also [Vue issue](https://github.com/vuejs/core/issues/6876), [Reactivity Tra ::: warning -[Reactivity Transform](https://vuejs.org/guide/extras/reactivity-transform.html) is required. You should enable it first. +[响应性语法糖](https://cn.vuejs.org/guide/extras/reactivity-transform.html) 是必须的。你必须先开启它。 ::: -## Basic Usage +## 基本用法 ```vue ``` -## Volar Configuration +## Volar 配置 ```jsonc {6} // tsconfig.json diff --git a/docs/zh-CN/macros/define-render.md b/docs/zh-CN/macros/define-render.md index ee96c3919..b0fd84569 100644 --- a/docs/zh-CN/macros/define-render.md +++ b/docs/zh-CN/macros/define-render.md @@ -1,17 +1,17 @@ # defineRender -Stability: stable +稳定性: 稳定 -Defining render function in ` ``` -## Volar Configuration +## Volar 配置 ```jsonc {6} // tsconfig.json diff --git a/docs/zh-CN/macros/setup-component.md b/docs/zh-CN/macros/setup-component.md index a6c7ae244..a931345cd 100644 --- a/docs/zh-CN/macros/setup-component.md +++ b/docs/zh-CN/macros/setup-component.md @@ -1,28 +1,30 @@ # setupComponent - Stability: experimental + 稳定性: 实验性 -Experimental, use at your risk +实验性功能,风险自负 ::: tip -If you're using `setupComponent`, then `defineRender` cannot be disabled. +如果您使用的是 `setupComponent`,则无法禁用 `defineRender`。 -Files in `node_modules` will not be ignored by default. +默认情况下不会忽略 `node_modules` 中的文件。 ::: -With `defineSetupComponent`, ` ``` -::: details Compiled Code +::: details 编译后代码 ```vue ``` -::: details Compiled Code +::: details 编译后代码 ```vue ``` -::: details Compiled Code +::: details 编译后代码 ```vue ``` -::: details Compiled Code +::: details 编译后代码 ```vue ``` -::: details Compiled Code +::: details 编译后代码 ```vue