-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update GitBook Release Instructions and npm deps
- Pin transitive lodash version - Rename package-lock to shrinkwrap - Release from _book instead of public - Update instructions for updating npm deps - use `npm ci`
- Loading branch information
Showing
4 changed files
with
198 additions
and
162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,32 @@ | ||
To push the docs run: | ||
|
||
- gitbook install # optional | ||
- gitbook build # build the html files | ||
- copy files from _book/ to public/ # copy the files to the deploy dir | ||
- firebase deploy # deploy files to firebase | ||
## Install phantomJs | ||
|
||
Install phantomJs which is required to build some images | ||
|
||
- `$ npm install phantomjs-prebuilt` | ||
|
||
## Install node_modules | ||
|
||
Install these as they aren't checked into the repo. | ||
|
||
- `$ npm ci` | ||
|
||
## Run locally | ||
|
||
Check that everything looks good | ||
|
||
- `$ gitbook serve` | ||
|
||
## Build the book | ||
|
||
Build the index.html & friends | ||
|
||
- `$ gitbook build` | ||
|
||
## Push the book | ||
|
||
Push the changes to firebase | ||
|
||
- `$ firebase deploy` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"hosting": { | ||
"public": "public", | ||
"public": "_book", | ||
"ignore": [ | ||
"firebase.json", | ||
"**/.*", | ||
|
Oops, something went wrong.