Skip to content

Commit

Permalink
adding hints plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
gnunicorn committed May 9, 2019
1 parent c68caf3 commit f5182b2
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
11 changes: 8 additions & 3 deletions README.md
Expand Up @@ -14,17 +14,22 @@ discussions.

You can also use gitbook tooling to view the spec locally.

First, install `gitbook-cli` via npm and run:
First, install `gitbook-cli` via npm then run the following to install all necessary plugins:
```
gitbook install
```

Now you can have gitbook serve it to you (with live-reload) via:
```
gitbook serve
```

Alternatively, you can use gitbook to print a pdf using:
Alternatively, you can use gitbook to print a pdf (or epub, or mobi) using:
```
gitbook pdf
```

(Note: on macOS using the pdf printer may require some extra installation)
(Note: on macOS using the pdf printer may require some extra installation, epub and mobi might require callibre to be installed, too)

If you're just browsing on GitHub, start with [INTRO.md](INTRO.md) and the
table of contents in [SUMMARY.md](SUMMARY.md). But really, we recommend using
Expand Down
10 changes: 9 additions & 1 deletion book.json
Expand Up @@ -3,5 +3,13 @@
"structure": {
"readme": "INTRO.md"
},
"plugins": ["-sharing"]
"plugins": ["-sharing", "hints"],
"pluginsConfig": {
"hints": {
"info": "fa fa-asterisk",
"tip": "fa fa-hand-o-right",
"danger": "fa fa-warning",
"working": "fa fa-wrench"
}
}
}

0 comments on commit f5182b2

Please sign in to comment.