diff options
| author | Samy Pessé <samypesse@gmail.com> | 2016-12-22 10:18:38 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-12-22 10:18:38 +0100 |
| commit | 194ebc3da9641ff96f083f9d8ab43c2d27944f9a (patch) | |
| tree | c50988f32ccf18df93ae7ab40be78e9459642818 /packages/gitbook-plugin-hints/README.md | |
| parent | 64ccb6b00b4b63fa0e516d4e35351275b34f8c07 (diff) | |
| parent | 16af264360e48e8a833e9efa9ab8d194574dbc70 (diff) | |
| download | gitbook-194ebc3da9641ff96f083f9d8ab43c2d27944f9a.zip gitbook-194ebc3da9641ff96f083f9d8ab43c2d27944f9a.tar.gz gitbook-194ebc3da9641ff96f083f9d8ab43c2d27944f9a.tar.bz2 | |
Merge pull request #1543 from GitbookIO/dream
React for rendering website with plugins
Diffstat (limited to 'packages/gitbook-plugin-hints/README.md')
| -rw-r--r-- | packages/gitbook-plugin-hints/README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/packages/gitbook-plugin-hints/README.md b/packages/gitbook-plugin-hints/README.md new file mode 100644 index 0000000..9952b97 --- /dev/null +++ b/packages/gitbook-plugin-hints/README.md @@ -0,0 +1,41 @@ +Styled hint blocks in your docs +============== + +This plugins requires gitbook `>=4.0.0`. + +### Install + +Add the below to your `book.json` file, then run `gitbook install` : + +```json +{ + "plugins": ["hints"] +} +``` + +### Usage + +You can now provide hints in various ways using the `hint` tag. + +```markdown +{% hint style='info' %} +Important info: this note needs to be highlighted +{% endhint %} +``` + +##### Styles + +Available styles are: + +- `info` (default) +- `tip` +- `danger` +- `warning` + +##### Custom Icons + +```markdown +{% hint style='info' icon="mail" %} +Important info: this note needs to be highlighted +{% endhint %} +``` |