You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs: bring user straight to the guide
* docs: use index instead of README
* docs: update CTA to go to get started guide
* docs: add update step for generator and remove older warnings
* docs: add warning for webpack 3 with less prominence
* docs: update node prerequisite version
* docs: fix link for create-vuepress
* docs: remove upgrade step
\*_If your project is using webpack 3.x, you may notice some installation issues with npm. In this case, we recommend using Yarn._
6
9
7
10
## Quick Start
8
11
9
-
The fastest way to get your VuePress project setup is to use our create-vuepress tool which will help scaffold the basic VuePress site structure for you.
12
+
The fastest way to get your VuePress project setup is to use our [create-vuepress-site generator](https://github.com/vuepressjs/create-vuepress-site/) which will help scaffold the basic VuePress site structure for you.
10
13
11
14
To use it, open up your terminal in the desired directory and run the following command:
12
15
13
16
```bash
14
-
yarn create vuepress [directoryName]
15
-
# OR npx create-vuepress [directoryName]
17
+
yarn create vuepress-site [optionalDirectoryName]
18
+
# OR npx create-vuepress-site [optionalDirectoryName]
16
19
```
17
20
18
-
You will be prompted to choose which boilerplate you prefer. For most users, the `docs` boilerplate is what you will want.
19
-
20
21
You will then have the opportunity to configure your VuePress site’s metadata such as:
21
22
22
23
- Project Name
@@ -27,43 +28,39 @@ You will then have the opportunity to configure your VuePress site’s metadata
27
28
28
29
Once it is complete, you should see your new VuePress site scaffolded in your directory! :tada:
29
30
30
-
## Manual Setup
31
+
## Manual Installation
31
32
32
33
This section will help you build a basic VuePress documentation site from ground up. If you already have an existing project and would like to keep documentation inside the project, start from Step 3.
33
34
34
35
1. Create and change into a new directory
35
36
36
-
```bash
37
+
```bash
37
38
mkdir vuepress-starter &&cd vuepress-starter
38
39
```
39
40
40
41
2. Initialize with your preferred package manager
41
42
42
-
```bash
43
+
```bash
43
44
yarn init # npm init
44
45
```
45
46
46
47
3. Install VuePress locally
47
48
48
-
```bash
49
+
```bash
49
50
yarn add -D vuepress # npm install -D vuepress
50
51
```
51
52
52
-
::: warning
53
-
We currently recommend using [Yarn](https://classic.yarnpkg.com/lang/en/) instead of npm when installing VuePress into an existing project that has webpack 3.x as a dependency, because npm fails to generate the correct dependency tree in this case.
0 commit comments