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

Added comment about gitbook to building the book

Browse Source
This commit is contained in:
Stephen Asbury 2019-05-15 14:46:28 -07:00
parent b2d09e1a26
commit 033cfb44fe
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
building_the_book.md
View File

@ -1,5 +1,11 @@
# Building the Book
Before doing anything else, install the legacy command line for gitbook:
```bash
npm install -g gitbook-cli
```
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.
Icons for dev examples are from https://cdn.materialdesignicons.com/3.6.95/.