0.0.5 • Published 7 years ago
gitbook-plugin-glossary-tooltip v0.0.5
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.
Add Plugin
book.json
{
"plugins": ["glossary-tooltip"]
}then run
$ gitbook installConfigure (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:
Sample output
Pull requests are welcome