File tree 1 file changed +17
-15
lines changed
1 file changed +17
-15
lines changed Original file line number Diff line number Diff line change 1
1
# Deploying
2
2
3
- The following guides assumes you are placing your docs inside the ` docs ` directory of your project and using the default build output location.
3
+ The following guides are based on a few shared assumptions:
4
+
5
+ - You are placing your docs inside the ` docs ` directory of your project;
6
+ - You are using the default build output location (` .vuepress/dist ` );
7
+ - VuePress is installed as a local dependency in your project, and you have setup the following npm scripts:
8
+
9
+ ``` json
10
+ {
11
+ "scripts" : {
12
+ "docs:build" : " vuepress build docs"
13
+ }
14
+ }
15
+ ```
4
16
5
17
## GitHub Pages
6
18
7
- 1 . Set correct ` base ` in ` .vuepress/config.js ` .
19
+ 1 . Set correct ` base ` in ` .vuepress/config.js ` .
8
20
9
21
If you are deploying to ` https://<USERNAME>.github.io/ ` , you can omit ` base ` as it defaults to ` "/" ` .
10
22
@@ -23,7 +35,7 @@ You can also run this script in your CI setup to enable automatic deployment on
23
35
set -e
24
36
25
37
# build
26
- vuepress build docs
38
+ npm run docs:build
27
39
28
40
# navigate into the build output directory
29
41
cd docs/.vuepress/dist
46
58
47
59
## Netlify
48
60
49
- 1 . Make sure you have npm scripts for building your docs:
50
-
51
- ``` json
52
- {
53
- "scripts" : {
54
- "docs:build" : " vuepress build docs"
55
- }
56
- }
57
- ```
58
-
59
- 2 . On Netlify, setup up a new project from GitHub with the following settings:
61
+ 1 . On Netlify, setup up a new project from GitHub with the following settings:
60
62
61
63
- ** Build Command:** ` npm run docs:build ` or ` yarn docs:build `
62
64
- ** Publish directory:** ` docs/.vuepress/dist `
63
65
64
- 3 . Hit the deploy button!
66
+ 2 . Hit the deploy button!
You can’t perform that action at this time.
0 commit comments