Skip to content

Commit d505c93

Browse files
authored
docs: add @vue-macros/cli (#575)
1 parent 3c727b6 commit d505c93

File tree

2 files changed

+96
-0
lines changed

2 files changed

+96
-0
lines changed

docs/guide/getting-started.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,54 @@ We assume you are already familiar with the basic usages of Vue before you conti
1212
- VSCode with the **latest** [Vue Language Features (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) extension.
1313
- ❌ WebStorm is not supported.
1414

15+
## Creating a Vue Macros Project
16+
17+
### Installation
18+
19+
::: code-group
20+
21+
```bash [npm]
22+
npm i -g @vue-macros/cli
23+
```
24+
25+
```bash [yarn]
26+
yarn global add @vue-macros/cli
27+
```
28+
29+
```bash [pnpm]
30+
pnpm add -g @vue-macros/cli
31+
```
32+
33+
:::
34+
35+
This command will install [@vue-macros/cli](https://github.com/vue-macros/vue-macros-cli), the official Vue Macros scaffolding tool.
36+
37+
### Initialization
38+
39+
::: code-group
40+
41+
```bash [npm]
42+
npm create vite@latest my-vue-macros -- --template vue-ts
43+
cd my-vue-macros
44+
vue-macros init
45+
```
46+
47+
```bash [yarn]
48+
yarn create vite my-vue-macros --template vue-ts
49+
cd my-vue-macros
50+
vue-macros init
51+
```
52+
53+
```bash [pnpm]
54+
pnpm create vite my-vue-macros --template vue-ts
55+
cd my-vue-macros
56+
vue-macros init
57+
```
58+
59+
You will be presented with prompts for several optional experimental features.
60+
61+
:::
62+
1563
## Demos
1664

1765
- [Vite + Vue 3](https://github.com/vue-macros/vite)

docs/zh-CN/guide/getting-started.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,54 @@ Vue Macros 是一个库,用于实现尚未被 Vue 正式实现的提案或想
1212
- VSCode 安装了 [Vue Language Features (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) 扩展
1313
- ❌ 不支持 WebStorm
1414

15+
## 搭建第一个 Vue Macros 项目
16+
17+
### 安装
18+
19+
::: code-group
20+
21+
```bash [npm]
22+
npm i -g @vue-macros/cli
23+
```
24+
25+
```bash [yarn]
26+
yarn global add @vue-macros/cli
27+
```
28+
29+
```bash [pnpm]
30+
pnpm add -g @vue-macros/cli
31+
```
32+
33+
:::
34+
35+
这一指令将会安装 [@vue-macros/cli](https://github.com/vue-macros/vue-macros-cli),它是 Vue Macros 官方的项目脚手架工具。
36+
37+
### 初始化
38+
39+
::: code-group
40+
41+
```bash [npm]
42+
npm create vite@latest my-vue-macros -- --template vue-ts
43+
cd my-vue-macros
44+
vue-macros init
45+
```
46+
47+
```bash [yarn]
48+
yarn create vite my-vue-macros --template vue-ts
49+
cd my-vue-macros
50+
vue-macros init
51+
```
52+
53+
```bash [pnpm]
54+
pnpm create vite my-vue-macros --template vue-ts
55+
cd my-vue-macros
56+
vue-macros init
57+
```
58+
59+
你将会看到一些可选的实验性功能提示。
60+
61+
:::
62+
1563
## 示例
1664

1765
- [Vite + Vue 3](https://github.com/vue-macros/vue-macros/tree/main/playground/vue3)

0 commit comments

Comments
 (0)