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
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.
10
+
11
+
To use it, open up your terminal in the desired directory and run the following command:
12
+
13
+
```bash
14
+
yarn create vuepress [directoryName]
15
+
# OR npx create-vuepress [directoryName]
16
+
```
17
+
18
+
You will be prompted to choose which boilerplate you prefer. For most users, the `docs` boilerplate is what you will want.
19
+
20
+
You will then have the opportunity to configure your VuePress site’s metadata such as:
21
+
22
+
- Project Name
23
+
- Description
24
+
- Maintainer Email
25
+
- Maintainer Name
26
+
- Repository URL
27
+
28
+
Once it is complete, you should see your new VuePress site scaffolded in your directory! :tada:
29
+
30
+
## Manual Setup
31
+
7
32
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.
8
33
9
34
1. Create and change into a new directory
@@ -20,8 +45,6 @@ This section will help you build a basic VuePress documentation site from ground
20
45
21
46
3. Install VuePress locally
22
47
23
-
Globally installed VuePress is no longer recommended.
0 commit comments