taigrr/nats.docs
1
0
Fork 0
mirror of https://github.com/taigrr/nats.docs synced 2025-01-18 04:03:23 -08:00
Code Issues Projects Releases Wiki Activity

Add notes on building the book and running server

Browse Source
This commit is contained in:
Waldemar Quevedo 2019-06-17 20:20:22 -07:00 committed by GitHub
parent ceb702571c
commit ea0d1d40c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
building_the_book.md
View File

@ -6,6 +6,17 @@ Before doing anything else, install the legacy command line for gitbook:
npm install -g gitbook-cli npm install -g gitbook-cli
``` ```
There is a `Makefile` in the repo that can help building the book easier. To build and run the docs site http server locally:
```bash
make && make serve
...
info: >> generation finished with success in 45.3s !
Starting server ...
Serving book on http://localhost:4000
```
Docs are available as separate items in https://github.com/GitbookIO/gitbook/tree/6efbb70c3298a9106cb2083648624fd1b7af51c0/docs. All of the links go to the new site so you have to poke around manually. Docs are available as separate items in https://github.com/GitbookIO/gitbook/tree/6efbb70c3298a9106cb2083648624fd1b7af51c0/docs. All of the links go to the new site so you have to poke around manually.
The build uses https://github.com/Bandwidth/gitbook-plugin-include-html to include html directly for code examples as well as the prism plugin, https://github.com/gaearon/gitbook-plugin-prism, to handle code highlighting. CSS for code highlighting seems to get mucked up sometimes if you don't use the default them, this is something to work on in the future. We are also using https://github.com/poojan/gitbook-plugin-toggle-chapters, tried https://github.com/rtCamp/gitbook-plugin-collapsible-menu but it messed up the HTML. The build uses https://github.com/Bandwidth/gitbook-plugin-include-html to include html directly for code examples as well as the prism plugin, https://github.com/gaearon/gitbook-plugin-prism, to handle code highlighting. CSS for code highlighting seems to get mucked up sometimes if you don't use the default them, this is something to work on in the future. We are also using https://github.com/poojan/gitbook-plugin-toggle-chapters, tried https://github.com/rtCamp/gitbook-plugin-collapsible-menu but it messed up the HTML.
@ -20,4 +31,4 @@ To build the examples
or just use the make file `make` will download the gitbook plugins, build the example html and build the book. or just use the make file `make` will download the gitbook plugins, build the example html and build the book.
`make serve` will just serve the files without all the other prep work. `make serve` will just serve the files without all the other prep work.