Instantly share code, notes, and snippets.

What would you like to do?
PDF slides and handouts using Pandoc and Beamer

Files to create slides and handouts from the same Markdown files using Pandoc and a custom Beamer template. Lots of ideas borrowed from Karl Browman's post. The Makefile will turn any *.md in the directory into PDF slides (*.md.slides.pdf) and PDF slides with notes for speaking or a handout (*.md.handout.pdf). The file default.beamer belongs in ~/.pandoc/templates. Use the metadata in the YAML header of the Markdown file to control various options. To get the handout to look right, use the \note{} macro after each slide in the Markdown file.

% Generated by my modifications to the default Pandoc beamer template.
% Karl Browman has a tutorial about how to make Beamer sane:
% 12pt by default; handout if the handout template variable is defined
% theme, colortheme, and fonttheme with sensible defaults
% if it is a handout show the notes text; otherwise don't
\setbeameroption{show notes}
\setbeamertemplate{note page}[plain]
\setbeameroption{hide notes}
\setbeamertemplate{note page}[plain]
% Don't show things we don't want to see
\hypersetup{pdfpagemode=UseNone} % don't show bookmarks on initial view
% Slide number in lower right
% Space between paragraphs on notes page
\addtobeamertemplate{note page}{\setlength{\parskip}{12pt}}
% Color and shape of bullets
% \setbeamercolor{item}{fg=gray}
% \setbeamercolor{subitem}{fg=gray}
% \setbeamercolor{itemize/enumerate subbody}{fg=gray}
\setbeamertemplate{itemize item}{{\textendash}}
\setbeamertemplate{itemize subitem}{{\textendash}}
\setbeamerfont{itemize/enumerate subbody}{size=\footnotesize}
\setbeamerfont{itemize/enumerate subitem}{size=\footnotesize}
\usepackage{fixltx2e} % provides \textsubscript
% These lines are needed to make table captions work with longtable:
% Redefine \includegraphics so that, unless explicit options are
% given, the image width will not exceed the width of the page.
% Images get their normal width if they fit onto the page, but
% are scaled down if they would overflow the margins.
% Comment these out if you don't want a slide with just the
% part/section/subsection/subsubsection title:
% avoid problems with \sout in headers with hyperref:
\setlength{\parskip}{6pt plus 2pt minus 1pt}
\setlength{\emergencystretch}{3em} % prevent overfull lines
\VerbatimFootnotes % allows verbatim text in footnotes
\author{$for(author)$$author$$sep$ \and $endfor$}
\setbeamertemplate{footline}{} % no page number here
% Include a note for the title slide here, because we cannot do so in the
% Pandoc markdown file. If you want the title note to contain actual text,
% use the titlepage-note field in the YAML header. Otherwise, we use a
% non-breaking space so that it is not empty.
SLIDES := $(patsubst,,$(wildcard *.md))
HANDOUTS := $(patsubst,,$(wildcard *.md))
all : $(SLIDES) $(HANDOUTS) :
pandoc $^ -t beamer --slide-level 2 -o $@ :
pandoc $^ -t beamer --slide-level 2 -V handout -o $@
pdfnup $@ --nup 1x2 --no-landscape --keepinfo \
--paper letterpaper --frame true --scale 0.9 \
--suffix "nup"
mv $*.md.handout-nup.pdf $@
clobber :
rm -f $(SLIDES)
rm -f $(HANDOUTS)
author subtitle title titlepage-note institute fontsize
Lincoln Mullen
Doing DH Institute
Spatial History
This is a the note that goes on the title page. This talk is to be given at Doing DH.
George Mason University

Slide with text and a note

Regular text size

\tiny Jonathan Sarna, American Judaism (New Haven: Yale University Press, 2014)

\note{ NOTES: This is a note page and you ought to be able to tell. }

Slide with text and footnote

Surely this is true.^[Jane Doe, Says It Here (New York: Oxford University Press, 2050).]

\note{I am sure about this point.}

This is a heading

Regular text on a slide:

  • One
  • Two
  • Three

\note{ More notes:

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. }

Code example

puts "Hello world."
def my_awesome_variable
  puts "My awesome variable"

\note{ This might be easier in R or Ruby. }

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This comment has been minimized.

Copy link

pavelrudnev commented Feb 5, 2015

This is very useful, thanks. I was wondering how one should go about changing the compiler: where do I declare that I want the slides to be compiled with, say, XeLaTeX?


This comment has been minimized.

Copy link

daaronr commented Dec 27, 2015

Some things were coming out in the original template that I have lost by tweaking too much, I cannot recover these.

  1. I want to get the 'highlighted quotes' back when I use the environment:

This is a quote

  1. Also, sublists are now using a smaller font, e.g.,
  2. First element
    • Second element

The 'second element' is a smaller font.

My adapted template is here:

Compiling the sample file here:

with the command

pandoc -t beamer --slide-level=2 -o testnoteslides.pdf --verbose


This comment has been minimized.

Copy link

matthiasbeyer commented May 25, 2016

Hi there. May I take your code here and open a repository with it and license it under terms of ?


This comment has been minimized.

Copy link

hasufell commented Oct 27, 2016

Getting error:

! Undefined control sequence.
<recently read> \tightlist 

l.139 \end{frame}

pandoc: Error producing PDF

had to add


This comment has been minimized.

Copy link

iphyer commented Mar 10, 2017

How to change background color?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment