Reveal Slides for Github Pages via Pandoc

slides available at https://display-lab.github.io/slides-template

Making a New Presentation

Clone and rename this repository. Use your desired project name instead of newname below:

git clone --shallow-submodules --recurse-submodules \
  https://github.com/display-lab/slides-template.git newname

Writing & Building Slides

Create entire slide deck (index.html) from markdown files in slides/ directory. Slide will be assembled in alphabetical order by filename.

pandoc -t revealjs --template=pandoc-templates/default.revealjs \
  -o index.html  --slide-level=2 \
  -V reveal.js=./reveal.js  -V theme=white slides/*.md

Publishing to Github Pages

1. Create repo: https://github.com/new
2. Set repo as remote

   git remote set-url origin URL_TO_YOUR_REPO

3. Push up contents

   git push --set-upstream origin gh-pages

4. Change repository settings on github to serve Github Pages from gh-branch. more info

Dependencies

Pandoc

Required and used to generate the slides html.

Installation: https://pandoc.org/installing.html

Jekyll

The underlying technology that powers github pages. Not required to generate slides, but useful for examining how the github pages branch will be processed.

Installation: https://jekyllrb.com/docs/installation/