toxsick / gitbook-plugin-blurbs

Blurbs (hints) in GitBook, supports content parsing

GitBook Blurbs plugin

This Gitbook plugin improves the hints plugin, which seems inactive. This plugin supports parsing enclosed markdown text in the blurb.

Install

Add following to book.json.

{
    "plugins": ["blurbs"]
}

Usage

Markdown/Asciidoc content is parsed.

{% blurb style='tip', title='Important notice' %}
Render this link: [Google](https://google.com)
{% endblurb %}

Support arguments:

• style - info(default), tip, danger, warning, danger, help, build.
• type - markdown(default) or asciidoc.
• title - Title of the blurb.

Icons

Icons used in this plugin are taken from Material icons. These icons are licensed under Apache v2, see git repo.