New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

jekyll-sidenotes

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jekyll-sidenotes

  • 0.0.1
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

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

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

How to implement tufte css in jekyll. simply jekyll

For sidenote implementation comparisons. gwern.net

FAQs

Package last updated on 07 Dec 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc