public
Description: Generate syntax-highlighted slides from Markdown
Homepage: http://nakajima.github.com/slidedown
Clone URL: git://github.com/nakajima/slidedown.git
commit  99596b754333b9986bd66dcb0203e107642245c8
tree    678ce2dbf6eabc7aad9b90c75e73fb74fd74991e
parent  c724b814102201036b054e3c84c811303f7ecabb
name age message
file .gitignore Sun Jun 21 16:04:07 -0700 2009 added --template option & second template, the ... [dancroak]
file README.md Thu Sep 24 11:52:56 -0700 2009 adding details about navigation, rhtml formatti... [dancroak]
file Rakefile Thu Sep 24 11:52:56 -0700 2009 using Jeweler to get 0.1.2 building [dancroak]
file TODO Tue Mar 10 00:30:48 -0700 2009 Added TODO, gussied up README [nakajima]
file VERSION Thu Sep 24 11:52:56 -0700 2009 using Jeweler to get 0.1.2 building [dancroak]
directory bin/ Sun Jun 21 16:04:07 -0700 2009 added --template option & second template, the ... [dancroak]
file deps.rip Mon Aug 10 14:07:02 -0700 2009 Added deps.rip [nakajima]
directory example/ Wed Sep 02 11:48:09 -0700 2009 Adding integration coverage for the command lin... [Jason Morrison]
directory lib/ Wed Sep 02 11:58:23 -0700 2009 Allow the -t commandline argument to accept abs... [Jason Morrison]
file slidedown.gemspec Thu Sep 24 11:52:56 -0700 2009 using Jeweler to get 0.1.2 building [dancroak]
directory spec/ Wed Sep 02 11:58:23 -0700 2009 Allow the -t commandline argument to accept abs... [Jason Morrison]
directory templates/ Thu Sep 24 11:32:07 -0700 2009 Go to the root url after pressing escape Signe... [Joe Ferris]
directory vendor/ Mon Aug 24 23:00:01 -0700 2009 Use open3 instead of open4 [nakajima]
README.md

slidedown

Generate slides with Markdown

Usage

Write your talk.

!SLIDE

# This is my talk

!SLIDE

## I hope you enjoy it

!SLIDE code

    def foo
      :bar
    end

!SLIDE

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

!SLIDE

# Questions?

Generate the output:

$ slidedown my-talk.md

Custom Styles

To add custom styles to your slides, just create stylesheets in the same directory as your presentation markdown file:

| - presentation-directory
  | - slides.md
  | - styles.css

The additional styles will be added to your generated slides.

Navigation

Give your presentation!

  • left, right arrows to navigate through slides
  • esc to go home

Syntax Highlighting

For Ruby:

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

For Javascript

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

For ERb:

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

Requirements

  • Nokogiri
  • makers-mark
  • pygments (for syntax highlighting)

Todo

  • Other means of navigation besides left/right keys
  • Vertical view of all slides in a row
  • Generate PDFs (maybe via cucumber)
  • Stop making Nokogiri sad when parsing out snippets

Contributors

  • Pat Nakajima
  • Dan Croak

(c) Copyright 2009 Pat Nakajima

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.