The copy-editor of the web
Simply select some text on this page and make a comment!
Adding annotation to any website is easy with Annotator. First, download the Annotator library, include it in your HTML.
var ann = Annotator(document.body);
Full instructions are in the Getting Started section of the docs.
To setup the default suite of plugins include annotator.min.css and annotator-full.min.js and call the "setupPlugins" method via .annotator(). For example:
var ann = Annotator(document.body); ann.setupPlugins()
The Annotator community has developed more than twenty plugins, such as:
- Annotorious - image annotation
- Touch Plugin - support for touch devices (iOS, Android, etc.)
- Offline Plugin - work on documents while offline, using localStorage
- Share-annotator - share text and video annotations using social networks or email
- richText-annotator - rich media and rich text annotations using Tinymce
For a full list of 3rd party Annotator plugins visit our plugin page.
How do I help?
We’re an open source project -- there are a number of ways to get involved. Here are a few:
- Fix (or report) bugs: If you find an issue with The Annotator, have a look at our issue tracker, and file a bug. If you’re a developer, feel free to fork the project and submit a pull request.
- Write documentation: If you find gaps in the documentation, you can pitch in there too. The process is similar: fork the project, edit the RST docs, and submit a pull request.
- Write a plugin: If you’ve written a plugin, chances are your code will be useful to others. Please add a link to the wiki so people can find your stuff.
If you’re interested in our community, or you’re having trouble with something, please join our mailing list.