mirror of
https://github.com/taigrr/nats.docs
synced 2025-01-18 04:03:23 -08:00
15 lines
830 B
Markdown
15 lines
830 B
Markdown
# Building the Book
|
|
|
|
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.
|
|
|
|
Icons for dev examples are from https://cdn.materialdesignicons.com/3.6.95/.
|
|
|
|
To build the examples
|
|
|
|
```bash
|
|
% go run tools/examplecompiler/main.go -o developer/examples -r tools/examplecompiler/example_repos.json -t tools/examplecompiler/example_template.tmp
|
|
```
|
|
|
|
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. |