glossary-tooltip

README

GitBook Glossary Tooltip Plugin

A plugin that uses tooltipjs to automatically transform glossary items into tooltips instead of seeing the default browser title attribute on hover.

npm version Build Status

Add Plugin

book.json

{
    "plugins": ["glossary-tooltip"]
}

then run

$ gitbook install

Configure (Optional Step)

book.json

"pluginsConfig": {
    "glossary-tooltip":{
        "parseGlossaryItems": false,
    }
}

Config Options:

Option Description
parseGlossaryItems {Boolean}
default: true
tells the plugin whether to apply tooltips to glossary items or not
trigger {string}
default: hover
the event that triggers the tooltip. one of ['hover', 'click', 'focus']
placement {string}
default: top
placement of the tooltip relative to the trigger element. one of ['top', 'bottom', 'left', 'right']"

Template

You can also place your own tooltip in your markdown

Args

tooltip takes one required named/unnamed argument:

  • topic (string): The text to display in the tooltip trigger element.

example:


{% tooltip "sample tooltip" %} sample tooltip test with **Emphasis** {% endtooltip %}

Sample output

output

Pull requests are welcome

Configuration

Setting Description Type Allowed values
parseGlossaryItems Boolean
default = true
-
placement String
default = top
-
trigger String
default = hover
-

Plugin

gitbook plugin to display glossary text as a tooltip

https://plugins.gitbook.com/plugin/glossary-tooltip


Latest: 0.0.5

0.0.1, 0.0.2, 0.0.3, 0.0.4, 0.0.5,

Requirements

GitBook
0.0.5 >=2.3.0

Maintainers

Open on NPM