blob: 9952b97ea1baf330cb1a86023d092cfa0285efc9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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 %}
```
|
