Side-Notes - My Sidenotes Plugin

Side-Notes

I first discovered sidenotes, at least in a conscious way, on Gwern.net which was referencing Edward Tufte's sidenote conventions.

Sidenotes Basics
Basic sidenote capabilities demonstrated

Neumorphic badges
An optional style that highlights references.

Editing sidenotes
Editing a sidenote in the margin, adding a new sidenote, then adding a new margin note

Side-Notes Plugin Listing

Features

Sidenotes

Numbered notes displayed in the margin instead of at the bottom of the note. Run the Insert sidenote command to start one.

Margin notes

Un-numbered notes in the margin, for asides that don't need a reference number. In Editing mode a small marker shows where the note is anchored; it can also be configured to open as a popup instead. Click to edit.

Numbering

Responsive layout

PDF export

Works with both HTML sidenotes and footnotes (experimental). Notes are laid out in the margin rather than inline, and margin notes are dropped from the endnote list at the end of the document.

Goal Features

Maybe Features

Alternatives and inspirations

Setup

  1. If copying manually from this repo, download the plugin from the Releases page.

  2. Add the plugin files to your Obsidian vault.
    Copy the contents into YOUR-VAULT/.obsidian/plugins/sidenotes.

  3. If copying manually, restart Obsidian and then enable the plugin in Settings.

  4. Configure the settings how you like:

    • Choose sidenote format:
      • Footnotes: Traditional Markdown footnotes will become sidenotes
        • Hide footnotes: Choose if you want to hide the origina footnotes at the bottom of the note
        • Hide footnote numbers: Hide the original Markdown reference numbers in the note text - e.g. this: [1]
      • HTML: uses <span> elements to format the sidenotes. I originally designed using this because it was an easy way for me to set up CSS styles in Obsidian as well as CSS styles in my web-published notes
    • Number style: Try 'neumorphic badge' for numbers that are more visually identifiable
    • Width & Spacing:
      • Minimum sidenote width
      • Maximum sidenote width
      • Minimum gap between sidenote and text
      • Minimum gap between sidenote and editor edge
    • Page offset factor: Make some room for the sidenotes if you want. This shifts the note text over (only affects notes that have sidenotes)

Use

Run the command Insert Sidenote.

If using HTML

It will insert this:

<span class="sidenote">{cursor}</span>

Click on the sidenote to edit it in the margin. Press ENTER to update. Press SHIFT+ENTER to add a new line in the sidenote.

If using footnotes

it will insert [^1] and add a footnote at the bottom of the document. Press ENTER to update. Using SHIFT+ENTER will not work to add a new line in a footnote because of how footnotes are formatted in Markdown.

Opposite margin

By default, every sidenote and margin note lands in whichever margin the Sidenote position setting points to. To pin a single note to the other margin instead, run Insert sidenote (opposite margin) or Insert margin note (opposite margin) from the command palette. These insert the same markup as the regular commands, plus a side marker:

Web Publishing

I use Digital Garden to publish a subset of my notes to a website. In the framework Digital Garden has set up, a CSS file called custom-styles.css is where one adds any CSS to modify the default styles.

The snippet of CSS I've been using for web publishing is located in /digital-garden/custom-styles.css.

Known issues