From 033cfb44fe29ed53d3260d6d3942b60ef39c2351 Mon Sep 17 00:00:00 2001 From: Stephen Asbury Date: Wed, 15 May 2019 14:46:28 -0700 Subject: [PATCH] Added comment about gitbook to building the book --- building_the_book.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/building_the_book.md b/building_the_book.md index ba530d0..b0a2dc0 100644 --- a/building_the_book.md +++ b/building_the_book.md @@ -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/.