diff options
| author | Samy Pesse <samypesse@gmail.com> | 2016-09-29 19:38:55 +0200 |
|---|---|---|
| committer | Samy Pesse <samypesse@gmail.com> | 2016-09-29 19:38:55 +0200 |
| commit | b5c407cf7bdea1a7b0da5044cb036e2753b32de2 (patch) | |
| tree | c9bbeb75f43e9b3090c6e8ce7d261e2660b47a80 /packages/gitbook-plugin-hints/README.md | |
| parent | 9d8dffb6f0aac87c3707a4171140fa66f7e2e82c (diff) | |
| download | gitbook-b5c407cf7bdea1a7b0da5044cb036e2753b32de2.zip gitbook-b5c407cf7bdea1a7b0da5044cb036e2753b32de2.tar.gz gitbook-b5c407cf7bdea1a7b0da5044cb036e2753b32de2.tar.bz2 | |
Start plugin "hints"
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 %} +``` |