gitbook-plugin-hints

1.0.2 • Public • Published

Styled hint blocks in your docs

This plugins requires gitbook >=2.0.0.

Install

Add the below to your book.json file, then run gitbook install :

{
    "plugins": ["hints"]
}

Usage

You can now provide hints in various ways using the hint tag.

{% hint style='info' %}
Important info: this note needs to be highlighted
{% endhint %}

The above example will produce a div with the appropriate style:

<div class="alert alert-info">
Important info: this note needs to be highlighted
</div>

Available styles are:

  • info (default)
  • tip
  • danger
  • working

Dependents (0)

Package Sidebar

Install

npm i gitbook-plugin-hints

Weekly Downloads

514

Version

1.0.2

License

Apache 2.0

Last publish

Collaborators

  • taranvohra
  • gitbook-bot
  • samypesse
  • jpreynat
  • emmerich
  • soreine