Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.17 KB

README.md

File metadata and controls

37 lines (25 loc) · 1.17 KB

annotater

a minimal, versatile annotating tool

annotater takes a target string (or regex) and hunts down every instance, chops it out of it's text node, wraps it in a tag, and adds a tooltip.

this makes it perfect for annotating rendered markdown.

demos

cursory use

include the library, annotater.js, and use it

annotater({
    name: 'stackoverflow.com',
    tooltip: 'you will likely stumble upon it during every bug hunt'
});

annotater({
    name: /foo|bar|baz/,
    tooltip: 'this is a placeholder variable that means "you can use anything here"'
});

it's also availablie via bower install annotater


that's the gist, but it does more than tooltips: tooltip interpolation, function templating, live models, match replacement, jekyll friendliness, and more.