Starter files for using Pandoc Markdown with Tufte CSS
This project aims to provide a standard set of project starter files for working with Pandoc and Tufte CSS. It features:
title
, subtitle
, date
, and author
Apart from projects like Tufte CSS & Pandoc, the main project that enables this
project is pandoc-sidenote
, a project which converts Pandoc Markdown-style
footnotes ([^1]
) into side notes.
Looking to use this with Jekyll?
You might be interested in Tufte Pandoc Jekyll, which wraps the files distributed here into a Jekyll gem-based theme.
Looking for the same features, but a different look?
You might be interested in Pandoc Markdown CSS Theme, a theme with much of the same features as this theme, but with a more easily customizable look.
If you haven't already, I encourage you to explore the projects that have been built on top of here:
pandoc-sidenote
- convert Pandoc Markdown-style footnotes into sidenotesDependencies
This project is always tested relative to:
- the most recent
master
commit oftufte-css
.- the latest release version of pandoc
In particular, you'll need at least Pandoc version 2.0.
This project is meant to be a set of starter files for your next project. What that ultimately means is that you should use these files however your heart sees fit. In practice, here are some tips for some things you may want to do to get set up.
First, install pandoc-sidenote
to your PATH.
pandoc
compile footnotes into sidenotes.pandoc-sidenote
homepage.Second, download tufte.css
and the et-book/
font folder.
tufte-css
to download these.tufte-css/
folder in this repo (it's a submodule).Third, there are a number of static files you can download and place where you see fit:
tufte.html5
--template
flag.pandoc.css
pandoc-solarized.css
(optional)
tufte-extra.css
(optional)
Finally, you'll want the Makefile
.
The best way to learn to use this project is to read the documentation--both online and in the source code. You'll probably want to look through things in this order
*.md
files into *.html
files
using pandoc
with the correct options.Once you have an understanding of what Markdown features are available, you can use the Makefile to compile your Markdown files.
For example, this is how we build the homepage for this site:
make docs/index.md
and here's how we build all the site files:
make docs
make
Assuming you've laid out your directory identically to this repo, you can pass
the name of any *.md
file to convert it into an appropriately named *.html
file.
make my-pandoc-markdown-file.md