From 36658097a49c0167c0d368c2526f1dacdc188c64 Mon Sep 17 00:00:00 2001 From: Lee Hinman Date: Fri, 2 Sep 2016 09:05:31 -0600 Subject: Update README --- README.org | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.org b/README.org index 1db334b..c3e886a 100644 --- a/README.org +++ b/README.org @@ -9,6 +9,49 @@ compatible with [[https://edwardtufte.github.io/tufte-css/][Tufte CSS]] out of t 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=). + +* 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 ~