Skip to content
This repository was archived by the owner on Dec 7, 2018. It is now read-only.

Commit 333867b

Browse files
author
Oscar Scholten
committed
Document mechanism to locally run and test
1 parent a394622 commit 333867b

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
.idea/
2-
*.iml
2+
*.iml
3+
node_modules/
4+
package-lock.json
5+
_book/

README-local.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
To locally compile and view the reference guide, run these commands:
2+
3+
$ npm install gitbook-cli
4+
5+
(npm will complain there is no package.json file, that can be ignored)
6+
7+
$ ./node_modules/gitbook-cli/bin/gitbook.js install
8+
9+
This installs the necessary plugins and the latest gitbook version
10+
11+
$ ./node_modules/gitbook-cli/bin/gitbook.js build
12+
13+
This builds the book into the _book folder
14+
15+
Alternatively, you can use:
16+
17+
$ ./node_modules/gitbook-cli/bin/gitbook.js serve
18+
19+
This starts a webserver at port 4000; it also monitors your .md files for
20+
changes, rebuilds the book and refreshes your browser tab.

0 commit comments

Comments
 (0)