Skip to content

Commit e680936

Browse files
committed
docs: tweak deploy guide
1 parent fa404dc commit e680936

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

docs/guide/deploy.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
# Deploying
22

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+
```
416

517
## GitHub Pages
618

7-
1. Set correct `base` in `.vuepress/config.js`.
19+
1. Set correct `base` in `.vuepress/config.js`.
820

921
If you are deploying to `https://<USERNAME>.github.io/`, you can omit `base` as it defaults to `"/"`.
1022

@@ -23,7 +35,7 @@ You can also run this script in your CI setup to enable automatic deployment on
2335
set -e
2436
2537
# build
26-
vuepress build docs
38+
npm run docs:build
2739
2840
# navigate into the build output directory
2941
cd docs/.vuepress/dist
@@ -46,19 +58,9 @@ cd -
4658

4759
## Netlify
4860

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:
6062

6163
- **Build Command:** `npm run docs:build` or `yarn docs:build`
6264
- **Publish directory:** `docs/.vuepress/dist`
6365

64-
3. Hit the deploy button!
66+
2. Hit the deploy button!

0 commit comments

Comments
 (0)