annotator-meltdown

Overview

Create annotator.js annotations with formatting using markdown notation and a simple toolbar for managing format markup.

Try it out in this simple demo.

Note: annotator-meltdown modifies the default Annotator.js keyboard shortcuts so that the enter key can be used to create new lines in the annotation text. Use shift+enter to save and close the current annotation.

Installation

Using this annotator plugin requires Meltdown CSS and javascript and the annotator-meltdown javascript. A minified version of the combined meltdown and annotator-meltdown css and javascript dependencies are provided for convenience.

Include the appropriate CSS and Javascript files:

<link rel="stylesheet" type="text/css" href="http://emory-lits-labs.github.io/annotator-meltdown/build/0.3.0/annotator.meltdown.min.css" />
<script type="text/javascript" src="http://emory-lits-labs.github.io/annotator-meltdown/build/0.3.0/annotator.meltdown.min.js"></script>

To use this plugin in your Annotator project, set annotator-meltdown as both a viewer and editor extension when you initialize annotator.ui.main. You can optionally configure a minimum width for the editor element:

    var app = new annotator.App();
    app.include(annotator.ui.main,{
      viewerExtensions: [
        annotatormeltdown.viewerExtension
      ],
      editorExtensions: [
        annotatormeltdown.getEditorExtension({min_width: '500px'})
      ]
    });

Dependencies

• jQuery 1.8+ (1.9.1 recommended)
• Annotator.js 2.x
• Meltdown

Authors and Contributors

Created by Rebecca Sutton Koeser (@rlskoeser) and Kevin Glover (@kevinglover), 2015. Originally developed as part of readux.