a Jekyll generator for Impress.js presentations
Switch branches/tags
Clone or download
Latest commit 7dacc7b Sep 5, 2015
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_layouts Merge pull request #23 from julien-noblet/upgrade_impressjs Sep 5, 2015
_posts Update README with more instructions. Add classes to frontmatter for … Jan 27, 2012
_sass Move partials into the hekyll theme. Feb 11, 2012
css Add syntax highlighting support. Feb 14, 2012
.gitignore Experimenting with a new color scheme and SASS generated stylesheet, … Jan 25, 2012
LICENSE Add MIT License. Sep 5, 2015
README.md Add a link to the history of Hekyll. Feb 23, 2012
_config.yml Change the deprecated pygments option to highlighter on _config.yml. Sep 5, 2015
impress.js Upgrade to 0.5.3 Feb 28, 2015
index.md Add links to the github project. Jan 19, 2012
preso.html Add page break divs for printing slides. Mar 5, 2012
print.html Add page break divs for printing slides. Mar 5, 2012

README.md

Hekyll

pronunciation: "heckle"

Authored by: Brian McMurray (bmcmurray) and Steven Merrill (smerrill)

Hekyll is a presentation generator that uses Jekyll and Impress.js to create awesome presentations. You write Markdown files, which get turned into individual slides for an Impress.js presentation.

Design Goals

Hekyll should:

  • Make it easy for hackers to write graphically-impressive presentations in Markdown.
  • Allow easier collaboration on these presentations through GitHub.
  • Allow users to commit and publish their presentations through GitHub using GitHub Pages.
  • Provide a good print stylesheet so that a user can print to PDF when conferences ask for slide decks.
  • Provide a simple slideshow mode for generating quick, regular slide shows (simple cross-fades between slides without the need to individually position each slide "Prezi-style."
  • Provide an easy way of dropping in new presentation themes.

How to Use Hekyll

  1. Download and install Jekyll.
  2. Download or clone the Hekyll repository.
  3. Configure options in _config.yml
  4. Create a new Markdown file for each slide in _posts. Use the post_template.md as a starting point. Be sure to name each file with a date, just like Jekyll.

Requirements

  • Jekyll

Acknowledgements

This project stands on the shoulders of giants and would not be possible without these projects:

History of Hekyll

Read the creation story of Hekyll on my blog.