Skip to content

GitBook plugin. Defines 4 types of styled hint blocks: info, danger, tip, working

Notifications You must be signed in to change notification settings

kilbot/plugin-hints

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 

Repository files navigation

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": ["plugin-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

About

GitBook plugin. Defines 4 types of styled hint blocks: info, danger, tip, working

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%