Jekyll and Slide
Jekyll and Slide is a skeleton Jekyll site that embeds hakimel's reveal.js framework for creating slideshows, letting you quickly write slideshows with Markdown. The site theme is Lanyon by mdo.
Contents
Usage
Create a site by cloning or downloading this repository. Navigate to the directory where you copied it and run jekyll serve to view the site in your browser at localhost:4000. Press ctrl + C in your terminal to stop the server.
Create new slideshows by writing .md files in the _slides directory. Use slide separators in your Markdown to create individual slides. index.html lists all the slideshows in the _slides directory.
If you want to use more complicated reveal.js features like fragments, you can just switch to HTML.
Options
You can customize Jekyll and Slide in a few ways:
Slide separators
You can define what characters to use as slide separators in _config.yml. By default these are:
reveal:
slide_separator: "<hr />"
vertical_separator: "<p>~~</p>"
notes_separator: "<p>Notes:</p>"
Slide separators are evaluated after the slide Markdown is rendered into HTML. So you can write ---- and ~~ for separators in your Markdown files, but Jekyll interprets them as <hr /> and <p>~~</p>.
Title slide
reveal:
title_slide: true
Slideshows will begin with a slide that shows the title, URL, and description defined in the file's front matter.
Themes
You can optionally specify a theme for slide decks in the front matter of a .md file:
---
theme: sky
---
The reveal.js readme lists the available themes. You can also make your own.
Author
Adam Hollett
License
Open sourced under the MIT license.
Credit
Thanks to hakimel, mdo, and ngoldman for the stuff that this is built on. I really didn't do much.
