Commit 438b56d 1 parent eb4fcb0 commit 438b56d Copy full SHA for 438b56d
File tree 3 files changed +19
-19
lines changed
3 files changed +19
-19
lines changed Original file line number Diff line number Diff line change @@ -10,18 +10,17 @@ being maintained.
10
10
11
11
The following are basic prerequisites for using Docsy in your site:
12
12
13
- - Install a recent release of the Hugo "extended" version (we recommend version
14
- 0.53 or later). If you install from the [ release
15
- page] ( https://github.com/gohugoio/hugo/releases ) , make sure you download the
16
- ` _extended ` version which supports SCSS.
13
+ - Install a recent release of the Hugo "extended" version. If you install from
14
+ the [ Hugo release page] ( https://github.com/gohugoio/hugo/releases ) , make sure
15
+ you download the ` _extended ` version which supports SCSS.
17
16
18
17
- Install ` PostCSS ` so that the site build can create the final CSS assets. You
19
18
can install it locally by running the following commands from the root
20
19
directory of your project:
21
20
22
21
``` console
23
- $ sudo npm install -D -- save autoprefixer
24
- $ sudo npm install -D -- save postcss-cli
22
+ $ npm install -- save-dev autoprefixer
23
+ $ npm install -- save-dev postcss-cli
25
24
```
26
25
27
26
## Example and usage
@@ -59,12 +58,10 @@ above:
59
58
``` console
60
59
$ git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git
61
60
$ cd docsy/userguide/
62
- $ hugo server --themesDir ../..
61
+ $ npm install
62
+ $ npm run serve
63
63
```
64
64
65
- Note: you need the ` themesDir ` flag when running Hugo because the site files are
66
- inside the theme repo.
67
-
68
65
## Contributing ![ GitHub] ( https://img.shields.io/github/contributors/google/docsy )
69
66
70
67
Please read
Original file line number Diff line number Diff line change 1
1
{
2
2
"scripts" : {
3
- "build:preview" : " cd userguide && npm run build:preview" ,
4
- "build:production" : " cd userguide && npm run build:production" ,
5
- "build" : " cd userguide && npm run build" ,
6
- "install" : " cd userguide && npm install" ,
7
- "serve" : " cd userguide && npm run serve" ,
3
+ "_docs" : " cd userguide && npm run" ,
4
+ "docs-install" : " cd userguide && npm install" ,
5
+ "build:preview" : " npm run _docs build:preview" ,
6
+ "build:production" : " npm run _docs build:production" ,
7
+ "build" : " npm run _docs build" ,
8
+ "serve" : " npm run _docs serve" ,
8
9
"submodule:get" : " git submodule update --init --recursive --depth 1" ,
9
10
"submodule:update" : " git submodule update --remote --recursive --depth 1"
10
11
},
Original file line number Diff line number Diff line change 1
1
{
2
2
"scripts" : {
3
- "_build" : " hugo --cleanDestinationDir -e dev -DFE --themesDir ../.." ,
4
- "_serve" : " hugo serve -DFE --themesDir ../.." ,
5
- "build:preview" : " hugo --cleanDestinationDir -e dev -DFE --minify --baseURL \" ${DEPLOY_PRIME_URL:-/}\" --themesDir ../.." ,
6
- "build:production" : " hugo --cleanDestinationDir --minify --themesDir ../.." ,
3
+ "_build" : " npm run _hugo-dev" ,
4
+ "_hugo" : " hugo --cleanDestinationDir --themesDir ../.." ,
5
+ "_hugo-dev" : " npm run _hugo -- -e dev -DFE" ,
6
+ "_serve" : " npm run _hugo-dev -- serve" ,
7
+ "build:preview" : " npm run _hugo-dev -- --minify --baseURL \" ${DEPLOY_PRIME_URL:-/}\" " ,
8
+ "build:production" : " npm run _hugo -- --minify" ,
7
9
"build" : " npm run _build" ,
8
10
"prebuild:preview" : " npm run submodule:get" ,
9
11
"prebuild:production" : " npm run submodule:get" ,
You can’t perform that action at this time.
0 commit comments