Welcome to Material-Tufte

One of the most distinctive features of Tufte’s style is his extensive use of sidenotes. Sidenotes are like footnotes, except they don’t force the reader to jump their eye to the bottom of the page, but instead display off to the side in the margin. Perhaps you have noticed their use in this document already. You are very astute.

This project experiments with adding Tuftean sidenotes to Material for MkDocs. It's a bit simpler than what you'll find in the Tufte CSS and more like what Bureau Gorbunov projects use.

Installing

1. Install Material for MkDocs. Either enable the toc.integrate feature or hide TOC altogether.

2. Drop in tufte-sidebars.css in your project and reference it like this:

   extra_css:
     - stylesheets/tufte-sidebars.css
   

Then add a sidenote to any piece of content like this:

<div class="md-has-sidebar">
  <main>
    This project experiments with adding Tuftean sidenotes to Material for MkDocs.
    It's a bit simpler than what you'll find in the Tufte CSS and more like what
    Bureau Gorbunov projects use.
  </main>

  <aside>
    This is a margin note – a sidenote without a footnote-style number.
    Footnotes aren't implemented yet, but would be nice to have, too.
  </aside>
</div>