Code Monkey home page Code Monkey logo

jekyll_and_hyde's Introduction

JekyllAndHyde

JekyllAndHyde is a HTML presentation generator that combines the simplicity of website generation via Jekyll with jQuery's Slippy presentation library. Together they create a super-simple, GitHub Pages-compatible slideshow platform in Ruby.

Jekyll

Jekyll is a blog aware static site generator that powers GitHub Pages. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. GitHub Pages is set up in a way that whenever you push markup files into its Git repository, Jekyll will automatically render them and generate a static website.

Slippy

Slippy is HTML presentation library written with jQuery that takes a HTML file in and plays the presentation in any browser.

Why?

Combining Jekyll and Slippy can provide a powerful yet simple solution to create presentations: use the jekyll_and_hyde gem to generate a Jekyll template with Slippy properly integrated; write slides with Makrdown or Textile; publish slides by pushing it to a Git repository; present slides on a browser.

How?

Installation:

> gem install jekyll_and_hyde

Generation:

> jh new my_slides
> cd my_slides
> jh generate my-first-slide

There are two options coming with the "new" task: the "--github" flag is to set up a branch for GitHub Pages during generation, which is the same as calling "jh github"; the "--template" option is to define the Git repository of the generated Jekyll template to download, by default, the value is git://github.com/jingweno/jekyll_and_hyde_template.git.

Other tasks:

> jh github
> jh list [SEARCH]
> jh help [TASK]

The "github" task is to set up branching information for GitHub Pages. The "list" task is to list all the available tasks by giving it an optional SEARCH term. The "help" task is to display usage for a specific task.

Demo

http://owenou.com/jekyll_and_hyde_demo

Screencast

http://vimeo.com/jingwenowenou/cook-up-presentations-with-jekyllandhyde

News

http://ruby5.envylabs.com/episodes/151-episode-148-february-8-2011

License

MIT License. Details see LICENSE.

jekyll_and_hyde's People

Contributors

owenthereal avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

jekyll_and_hyde's Issues

No images displayed

When I deploy the presentation to Heroku or Github, images are not displayed. If I switch off all CSS styles, the images appears.

Bash JH not found

Hmm, at first I thought perhaps it was my gems setup was causing a few issues with things however, after getting it sorted out every time I try to invoke "jh new dir" it claims that jh:command not found. I have tested several of my other gems (thor, rake, etc) and all are working, Any ideas? Btw love the concept

Please let me choose the clone URL for slippy submodule

The submodule's path is hardcoded in new.rb:4 and points to a repo that hasn't been updated for over a year.

Is there a reason why you don't use the official repository? And if you don't want to by default, please let me choose with an option.

I'd be willing to send you a pull request if you want.

Best,
André

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.