balinterdi / slidedown forked from nakajima/slidedown

Generate syntax-highlighted slides from Markdown

This URL has Read+Write access

balinterdi (author)
Fri Sep 18 11:21:47 -0700 2009
commit  e6472d2c8c661c378049cfa8962d13ec384c548b
tree    6b2285a885e468b537abbfb522492b507e2cd98e
parent  d619c9911e6715e6f81a856848d858361545b3e5
name age message
file .gitignore Sun Jun 21 16:04:07 -0700 2009 added --template option & second template, the ... [dancroak]
file README.md Loading commit data...
file Rakefile
file TODO Tue Mar 10 00:30:48 -0700 2009 Added TODO, gussied up README [nakajima]
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/
file slidedown.gemspec
directory spec/ Wed Sep 02 11:58:23 -0700 2009 Allow the -t commandline argument to accept abs... [Jason Morrison]
directory templates/
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. Currently, the syntax highlight lexer defaults to Ruby. Adding support for specifying languages is in the TODOs.

!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's markdown file:

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

The additional styles will be added to your generated slides.

Syntax Highlighting

slidedown syntax highlighting works just like Lighthouse's:

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

Or for JavaScript

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

Requirements

  • RDiscount
  • Nokogiri
  • pygments (for syntax highlighting)
  • [makers-mark][http://github.com/nakajima/makers-mark]

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.