scarlet

h1. Scarlet

Scarlet is a slideshow generator that uses Textile as a markup language.

h2. Current Status

Scarlet is still very young and immature. The very basic functionality is in place, and should work well most of the time. You probably shouldn't rely too much on it for slideshows that will need to be maintained, because the application design is still undergoing changes.

h2. Features

• Syntax Highlighting: If you have "Pygments":http://pygments.org/ installed, Scarlet will automatically highlight your code.
• Custom Templates: Create and re-use your own templates for the slideshows.
• PDF and LaTeX Generation: Highly experimental. Patches are welcome and very appreciated.

h2. TODO

• Finish writing tests
• Simple style customization

h2. Usage

h3. Step 1 – Install Scarlet

sudo gem install scarlet

h3. Step 2 – Create the directory for the slideshow(s) and copy the javascripts and stylesheets

scarlet -g my_slideshow

h3. Step 3 – Create and save your slideshow file with Textile in the previously created folder

!SLIDE cover
!TITLE Welcome to Scarlet!

h1. Scarlet

Welcome to Scarlet!

!SLIDE

h1. What is it?

Scarlet is a Textile slideshow generator with syntax highlighting. Written in Ruby.

!SLIDE

h1. Why Ruby?

Because it's simple! Here is some Ruby code:

@@@ ruby
  puts "Hello, Scarlet!"
@@@

The previous example contains three slides. The first slide has an XHTML class named "cover".

h3. Step 4 – Convert your slideshow file to XHTML

In the previously created folder:

scarlet slideshow.textile > slideshow.html

h3. Step 5 - Start the Show!

Open the converted html file in your browser of choice and bedazzle your audience with your über presentation skills.

h4. Keyboard Navigation:

• Right/Enter/Space Bar - Forward slide
• Left - Backward slide

• g - Jump to slide # (EG: 5g - jump to slide 5)

• Esc - Go to the first slide

h2. Contributors

• Matias Korhonen: PDF and LaTeX generation
• Blake Smith: Slide titles, awesome navigation, and bug fixes

h2. Special Thanks

• Pat Nakajima for creating "slidedown":http://github.com/nakajima/slidedown
• Matias Korhonen for forcing me to publish Scarlet

h2. Copyright

Copyright (c) 2009 João Carlos Cardoso, excluding the following files:

• Files under lib/scarlet/html/templates/javascripts/: ** jquery.easing.js: George McGinley Smith ** jquery.hash-changed.js: Pat Nakajima ** jquery.min.js: John Resig and the jQuery Team ** slides.js: Pat Nakajima. Edited by Blake Smith and João Carlos Cardoso.

• Files under lib/scarlet/html/templates/stylesheets/: ** slides.css: Based on the stylesheet for "slidedown":http://github.com/nakajima/slidedown created by Pat Nakajima ** syntax_*.css: Generated with "Pygments":http://pygments.org/

h2. License

Scarlet is released under the MIT License (see the LICENSE file).