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
\*_If your project is using webpack 3.x, you may notice some installation issues with npm. In this case, we recommend using Yarn._
8
+
\*_If your project is using webpack 3.x, you may notice some installation issues with `npm`. In this case, we recommend using Yarn._
9
9
10
10
## Quick Start
11
11
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.
12
+
The fastest way to get your VuePress project set up 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.
13
13
14
14
To use it, open up your terminal in the desired directory and run the following command:
You will then have the opportunity to configure your VuePress site’s metadata such as:
30
+
The command will interactively ask for details to configure your VuePress site’s metadata such as:
31
31
32
32
- Project Name
33
33
- Description
34
34
- Maintainer Email
35
35
- Maintainer Name
36
36
- Repository URL
37
37
38
-
Once it is complete, you should see your new VuePress site scaffolded in your directory! :tada:
38
+
Once this done, a scaffolded documentation site will be created in the `docs` directory (or custom directory name, if passed) under the current directory.
39
+
40
+
To see it in action, navigate into newly scaffolded directory, install the dependencies and start the local server:
41
+
42
+
<code-group>
43
+
<code-blocktitle="YARN"active>
44
+
```bash
45
+
cd docs
46
+
yarn install
47
+
yarn dev
48
+
```
49
+
</code-block>
50
+
51
+
<code-blocktitle="NPM">
52
+
```bash
53
+
cd docs
54
+
npm install
55
+
npm run dev
56
+
```
57
+
</code-block>
58
+
</code-group>
39
59
40
60
## Manual Installation
41
61
42
-
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.
62
+
If you prefer, you can build a basic VuePress documentation site from ground up instead of using the generator mentioned above.
63
+
64
+
Note: If you already have an existing project and would like to keep documentation inside the project, start from Step 3.
43
65
44
66
1. Create and change into a new directory
45
67
@@ -85,9 +107,9 @@ This section will help you build a basic VuePress documentation site from ground
0 commit comments