No release in over a year
Create sidenotes, like footnotes, in your jekyll blog by using [<left] and [>right] syntax.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0
 Project Readme

Jekyll::SideNotes

jekyll-sidenotes is similar to markdown footnotes, but adds notes that render to either the left or right of the main content. The style is inspired by tufte-css.

Installation

Add this line to your application's Gemfile:

gem 'jekyll-sidenotes'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install jekyll-sidenotes

Syntax

This is what a left-sidenote[<left] and a right-sidenote[>right] look like.

[<left]: the syntax looks similar to...
[>right]: ...regular markdown footnotes.

On medium to small sized screens, you can click on sidenote superscripts to show or hide their content.

Note:

  • Sidenotes increment together, but separately from footnotes2. So, for example, it’s possible for there to be a ‘1’ for both a standard markdown footnote and a sidenote.
  • Sidenotes require an “\n” after each definition to parse properly. A warning will display if there are missing newlines (regardless of sidenotes).

Influences

tufte css: For clean’n’simple sidenote css implementation

simply jekyll: How to implement tufte css in jekyll.

gwern.net: For sidenote implementation comparisons:

Other Projects

tufte-jekyll