Sidenote

🌱 Last Tended: 2021-08-03

Special syntax for sidenotes is supported. Their syntax is reminiscent of traditional markdown footnotes. In markdown files, they look like this (without spaces around the left/right carrots):

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

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

Which, once rendered, looks like:


This is what a left-sidenote the syntax looks similar to…1 and a right-sidenote …regular markdown footnotes. look like.


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

Notable Quirks 🐝

  • 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.
  1. Left sidenotes are functional for completeness sake, but this theme is not optimized for them as their placement above the graph is rather awkward.Β 

  2. A regular markdown footnote.Β 

πŸͺ§ πŸ›–
🌊