#+TITLE: Ox-tufte
#+AUTHOR: Lee Hinman
#+EMAIL: lee@elastic.co
* Introduction
This is an export backend for Org-mode that exports buffers to HTML that is
compatible with [[https://edwardtufte.github.io/tufte-css/][Tufte CSS]] out of the box (meaning no CSS modifications needed).
It's still a work-in-progress, but it works pretty well right now.
* Installation and Usage
Currently you need to manually install, do something like:
#+BEGIN_SRC emacs-lisp
(add-to-list 'load-path "/path/to/ox-tufte")
(require 'ox-tufte)
#+END_SRC
For usage, when exporting simple select "Tufte HTML" instead of regular HTML
export from the export menu (=C-c C-e=).
It's important that you download [[https://github.com/edwardtufte/tufte-css][tufte css]] and place it on your server (with the
fonts) and then reference it from your org-mode document by adding a header such
as:
#+BEGIN_SRC org
,#+HTML_HEAD:
#+END_SRC
* Features
ox-tufte supports *most* of the features from tufte-css, some in different ways
than expected.
- Footnotes become numbered Sidenotes from the tufte spec
- Margin notes can be created by having a link to ~mn:~ where the link text
gets transformed to the margin note, for example:
#+BEGIN_SRC fundamental
This is some regular text [[mn:1][this will be a margin note]]
#+END_SRC
- Anything in =#+BEGIN_QUOTE= blocks becomes an epigraph, where the =#+NAME= of
the quote becomes a reference in the ~