hints-istex

README

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-istex"]
}

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 styled alert, with an icon:

<div class="alert alert-info hints-alert">
  <div class="hints-icon"><i class="fa fa-info"></i></div>
  <div class="hints-container">
    <p>Important info: this note needs to be highlighted</p>
  </div>
</div>

Available styles are:

  • info (default)
  • tip
  • danger
  • working

Configuration

You can specify custom classes for the icons (or none) in your book.json:

{
    "plugins": ["hints-istex"],
    "pluginsConfig": {
        "hints": {
            "info": "fa fa-info-circle",
            "success": "fa fa-check-circle",
            "danger": "fa fa-exclamation-triangle",
            "warning": "fa fa-exclamation-circle"
        }
    }
}

Configuration

Setting Description Type Allowed values
danger CSS class for the 'danger' icons String
default = fa fa-exclamation-triangle
-
info CSS class for the 'info' icons String
default = fa fa-info-circle
-
success CSS class for the 'tip' icons String
default = fa fa-check-circle
-
warning CSS class for the 'working' icons String
default = fa fa-exclamation-circle
-

Plugin

Defines four types of styled hint blocks: info, danger, tip, working.

https://github.com/thomas88100/gitbook-plugin-hints-istex


Latest: 1.0.1

1.0.0, 1.0.1,

Requirements

GitBook
1.0.1 >2.x.x

Maintainers

Open on NPM