Skip to content

Commit 2a5d321

Browse files
author
Guillaume Chau
committed
docs: structure rework [ci skip]
1 parent 153c418 commit 2a5d321

File tree

9 files changed

+70
-24
lines changed

9 files changed

+70
-24
lines changed

docs/.vuepress/config.js

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module.exports = {
22
locales: {
33
'/': {
44
lang: 'en-US',
5-
title: 'Vue CLI',
5+
title: 'Vue CLI 3',
66
description: '🛠️ Standard Tooling for Vue.js Development'
77
}
88
},
@@ -30,7 +30,7 @@ module.exports = {
3030
link: '/config/'
3131
},
3232
{
33-
text: 'Dev Guide',
33+
text: 'Plugin Dev Guide',
3434
items: [
3535
{ text: 'Plugin Dev Guide', link: '/dev-guide/plugin-dev.md' },
3636
{ text: 'UI Plugin Info', link: '/dev-guide/ui-info.md' },
@@ -59,20 +59,21 @@ module.exports = {
5959
sidebar: {
6060
'/guide/': [
6161
'/guide/',
62+
'/guide/installation',
6263
{
63-
title: 'CLI',
64+
title: 'Basics',
6465
collapsable: false,
6566
children: [
66-
'/guide/creating-a-project',
6767
'/guide/prototyping',
68-
'/guide/plugins-and-presets'
68+
'/guide/creating-a-project',
69+
'/guide/plugins-and-presets',
70+
'/guide/cli-service'
6971
]
7072
},
7173
{
7274
title: 'Development',
7375
collapsable: false,
7476
children: [
75-
'/guide/cli-service',
7677
'/guide/browser-compatibility',
7778
'/guide/html-and-static-assets',
7879
'/guide/css',
@@ -85,9 +86,15 @@ module.exports = {
8586
],
8687
'/dev-guide/': [
8788
'/dev-guide/plugin-dev.md',
88-
'/dev-guide/ui-info.md',
89-
'/dev-guide/ui-api.md',
90-
'/dev-guide/ui-localization.md'
89+
{
90+
title: 'UI Development',
91+
collapsable: false,
92+
children: [
93+
'/dev-guide/ui-info.md',
94+
'/dev-guide/ui-api.md',
95+
'/dev-guide/ui-localization.md'
96+
]
97+
}
9198
]
9299
}
93100
}

docs/.vuepress/public/ui-analyzer.png

82.5 KB
Loading

docs/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ footer: MIT Licensed | Copyright © 2018-present Evan You
2424
<p>Vue CLI is fully configurable without the need for ejecting. This allows your project to stay up-to-date for the long run.</p>
2525
</div>
2626
<div class="feature">
27-
<h2>GUI on top of the CLI</h2>
27+
<h2>Graphical User Interface</h2>
2828
<p>Create, develop and manage your projects through an accompanying graphical user interface.</p>
2929
</div>
3030
<div class="feature">
@@ -39,10 +39,18 @@ footer: MIT Licensed | Copyright © 2018-present Evan You
3939

4040
## Getting Started
4141

42+
Install:
43+
4244
``` bash
4345
npm install -g @vue/cli
4446
# OR
4547
yarn global add @vue/cli
48+
```
49+
50+
Create a project:
4651

52+
``` bash
4753
vue create my-project
54+
# OR
55+
vue ui
4856
```

docs/config/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ sidebar: auto
1010

1111
Some global configurations for `@vue/cli`, such as your preferred package manager and your locally saved presets, are stored in a JSON file named `.vuerc` in your home directory. You can edit this file directory with your editor of choice to change the saved options.
1212

13+
You can also use the `vue config` command to inspect or modify the global CLI config.
14+
1315
## Target Browsers
1416

1517
See the [Browser Compatibility](../guide/browser-compatibility.md#browserslist) section in guide.

docs/guide/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ sidebarDepth: 0
66

77
<Bit/>
88

9+
::: warning
10+
This documentation is for `@vue/cli` version **3.x**. For the old `vue-cli`, see [here](https://github.com/vuejs/vue-cli/tree/v2#vue-cli--).
11+
:::
12+
913
Vue CLI is a full system for rapid Vue.js development, providing:
1014

1115
- Interactive project scaffolding via `@vue/cli`.
@@ -16,6 +20,7 @@ Vue CLI is a full system for rapid Vue.js development, providing:
1620
- Configurable via in-project config file;
1721
- Extensible via plugins
1822
- A rich collection of official plugins integrating the best tools in the frontend ecosystem.
23+
- A full graphical user intefrace to create and manage Vue.js projects.
1924

2025
Vue CLI aims to be the standard tooling baseline for the Vue ecosystem. It ensures the various build tools work smoothly together with sensible defaults so you can focus on writing your app instead of spending days wrangling with configurations. At the same time, it still offers the flexibility to tweak the config of each tool without the need for ejecting.
2126

docs/guide/cli-service.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,14 @@ If you have [npx](https://github.com/zkat/npx) available (should be bundled with
2929
npx vue-cli-service serve
3030
```
3131

32+
::: tip
33+
You can run scripts with additional features using the GUI with the `vue ui` command.
34+
:::
35+
36+
Here is the Webpack Analyzer from the GUI in action:
37+
38+
![UI Webpack Analyzer](/ui-analyzer.png)
39+
3240
## vue-cli-service serve
3341

3442
```

docs/guide/creating-a-project.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,5 @@
11
# Creating a Project
22

3-
## Installation
4-
5-
::: tip Node Version Requirement
6-
Vue CLI requires [Node.js](https://nodejs.org/) version 8 or above (8.10.0+ recommended). You can manage multiple versions of Node on the same machine with [nvm](https://github.com/creationix/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows).
7-
:::
8-
9-
``` bash
10-
npm install -g @vue/cli
11-
# OR
12-
yarn global add @vue/cli
13-
```
14-
15-
After installation, you will have access to the `vue` binary in your command line. You can verify that it is properly installed by simply running `vue`, which should present you with a help message listing all available commands.
16-
173
## vue create
184

195
To create a new project, run:

docs/guide/installation.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Installation
2+
3+
::: danger
4+
The package name changed from `vue-cli` to `@vue/cli`.
5+
If you have the previous `vue-cli` (1.x or 2.x) package installed globally, you need to uninstall it first with `npm uninstall vue-cli -g` or `yarn global remove vue-cli`.
6+
:::
7+
8+
::: tip Node Version Requirement
9+
Vue CLI requires [Node.js](https://nodejs.org/) version 8 or above (8.11.0+ recommended). You can manage multiple versions of Node on the same machine with [nvm](https://github.com/creationix/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows).
10+
:::
11+
12+
To install the new package, use on of those commands:
13+
14+
``` bash
15+
npm install -g @vue/cli
16+
# OR
17+
yarn global add @vue/cli
18+
```
19+
20+
After installation, you will have access to the `vue` binary in your command line. You can verify that it is properly installed by simply running `vue`, which should present you with a help message listing all available commands.
21+
22+
You can check you have the right version (3.x) with this command:
23+
24+
```bash
25+
vue --version
26+
```

docs/guide/plugins-and-presets.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Vue CLI uses a plugin-based architecture. If you inspect a newly created project
66

77
The plugin based architecture makes Vue CLI flexible and extensible. If you are interested in developing a plugin, check out the [Plugin Development Guide](../dev-guide/plugin-dev.md).
88

9+
::: tip
10+
You can install and manage Plugins using the GUI with the `vue ui` command.
11+
:::
12+
913
### Installing Plugins in an Existing Project
1014

1115
Each CLI plugin ships with a generator (which creates files) and a runtime plugin (which tweaks the core webpack config and injects commands). When you use `vue create` to create a new project, some plugins will be pre-installed for you based on your feature selection. In case you want to install a plugin into an already created project, you can do so with the `vue add` command:

0 commit comments

Comments
 (0)