Code Monkey home page Code Monkey logo

hekyll's Introduction

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.

hekyll's People

Contributors

bmcmurray avatar smerrill avatar

Watchers

Praveen Wicliff avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.