Skip to content
This repository

An HTML5 presentation builder

branch: master
README.md

KeyDown

KeyDown is another 'Presentation System in a single HTML page' inspired by Showoff, Slidedown, HTML5 Rocks, with a little Presentation Zen thrown in.

It uses the excellent deck.js and its extensions for the presentation.

Build Status at Travis.

Our Github Pages is a Sample Presentation

Usage

$ gem install keydown

Generate a Template

Get started by making a sample project:

$ keydown generate my_presentation

This will make:

| - my_presentation/
  | - css/               - Keydown CSS and a file for you to customize
  | - deck.js/
  | - images/            - Some Keydown images, but also for you
  | - js/                - Keydown JavaScript, and a file for you to customize
  | - slides.md

Write your presentation in Markdown

Edit slides.md and write your presentation as if it were going to be HTML (because it will be):

!SLIDE

# This is my talk

!SLIDE

## I hope you enjoy it

!SLIDE code

    def foo
      :bar
    end

!NOTES

  * make sure to explain the use of Ruby symbols    

!SLIDE

Google is [here](http://google.com)

!SLIDE

# Questions?

!NOTE blocks will be ignored when generating the HTML.

Generate the Deck

$ keydown slides slides.md

..will generate slides.html

Present

Give your presentation! Open slides.html in a browser and talk away:

  • left, right arrows to navigate through slides

Usage

Presentation Title

An optional first H1 before a !SLIDE is treated as the presentation title in the HTML <title>.

Slide classes

Any text that follows !SLIDE will be added to the slide as CSS classes.

!SLIDE dark

You can define your own CSS classes (see below).

Images

Your presentation will be generated in the same directory as your Markdown file. So URI references via relative paths are fine. So feel free to use the local images directory (see the generate task above).

Full Screen background images

Keydown supports slides with full screen background images, including attribution text.

!SLIDE

# This slide has a background image

}}} images/sunset.jpg

This slide will have sunset.jpg as a full-bleed background image. Its aspect ratio will be preserved.

If you wish to have attribution text, an icon (currently Flickr and Creative Commons graphics are supported via flickr and cc respectively), and link the text, separate the text with :: like this:

!SLIDE

# This slide has a background image

}}} images/sunset.jpg::cprsize::flickr::http:://flickr.com/cprsize

Syntax Highlighting

Code syntax highlighting is done via CodeMirror.

Mark your code by block escaping via @@@ or `

For Ruby:

@@@ ruby
    def foo
      :bar
    end
@@@

For JavaScript

``` js
    function foo() {
      return 'bar';
    }
```

For ERb:

@@@ rhtml
    <%= @post.created_at.to_s(:fancy) %>
@@@

Custom CSS

All css files in the css directory will be linked into your presentation HTML file.

Custom JavaScript.

All JavaScript files in the js directory will be linked in your presentation HTML file.

Deck.js Extensions

Any extension CSS and JS will be loaded if copied into the project.

Requirements

For Use

  • Ruby and Rubygems
  • Other dependent gems will be installed

For Development

  • RSpec
  • Nokogiri
  • Other dependent gems will be installed

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Thanks & Attribution

Thanks to:

  • HTML5 Rocks guys for the original great presentation template
  • @nakajima & Slidedown for some parsing
  • Caleb for making deck.js & testing it with Jasmine
  • The various Github guys for Albino, Gollum, etc.

Copyright

Copyright © Infews LLC. See LICENSE for details.

Something went wrong with that request. Please try again.