jQuery.sidenotes
Transform Markdown footnotes into superpowered sidenotes.
Visit the project page for full details.
Installation
Grab jquery.sidenotes.min.js
from the GitHub repo, upload it to a server, and add it to your document's head:
<script src="jquery.sidenotes.min.js"></script>
With Bower
jQuery.sidenotes is available as a Bower package.
bower install jquery.sidenotes --save
Usage
Apply the plugin to a jQuery object consisting of each post/document container on the page. There can only be one post per container, and each container must contain both the content of the post and its footnotes.
With no configuration (use sensible defaults):
$('.post').sidenotes();
Or, pass an options object:
$('.post').sidenotes({ 'removeRefMarkRegex': /-sn$/, 'initiallyHidden': true });
TODO
- Improve the docs
- Write tests for the rest of the spec.
- Set-up browser based test page with key-bindings (like project page)
License
Copyright 2013 Andrew Clark
Licensed under the MIT License