Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

slideshow gem - Slide Show (S9) - A Free Web Alternative to PowerPoint and Keynote in Ruby

branch: master
README.markdown

Slide Show (S9) - A Free Web Alternative to PowerPoint and Keynote in Ruby

DESCRIPTION

The Slide Show (S9) Ruby gem lets you create slide shows and author slides in plain text using a wiki-style markup language that's easy-to-write and easy-to-read. The Slide Show (S9) project also collects and welcomes themes and ships "out-of-the-gem" with built-in support for "loss-free" gradient vector graphics themes.

SYNOPSIS
    slideshow [global options] command [command options] [arguments...]

VERSION
    2.0.0

GLOBAL OPTIONS
    -c, --config=PATH - Configuration Path (default: ~/.slideshow)
    --verbose         - (Debug) Show debug messages
    --version         - Show version

COMMANDS
    build, b           - Build slideshow
    install, i         - Install template pack
    list, ls, l        - List installed template packs
    new, n             - Generate quick starter sample
    about, a           - (Debug) Show more version info
    help               - Shows a list of commands or help for one command

build Command

NAME
    build - Build slideshow

SYNOPSIS
    slideshow [global options] build [command options] FILE

COMMAND OPTIONS
    --h1                    - Set Header Level to 1 (default)
    --h2                    - Set Header Level to 2
    --takahashi             - Allow // for slide breaks
    --slide                 - Use only !SLIDE for slide breaks (Showoff Compatible)
    -o, --output=PATH       - Output Path (default: .)
    -t, --template=MANIFEST - Template Manifest (default: s6)

EXAMPLES
    slideshow build microformats
    slideshow build microformats.text            # Process slides using Markdown
    slideshow build microformats.textile         # Process slides using Textile
    slideshow build microformats.rst             # Process slides using reStructuredText
    slideshow build microformats -o slides       # Output slideshow to slides folder
    slideshow build microformats -t s5blank      # Use your own slide show templates (e.g. s5blank)

list Command

NAME
    list - List installed template packs

SYNOPSIS
    slideshow [global options] list [command options] 

EXAMPLES
    slideshow list
    slideshow ls

install Command

NAME
    install - Install template pack

SYNOPSIS
    slideshow [global options] install [command options] MANIFEST

COMMAND OPTIONS
    -a, --all - Template Packs (s5blank, s5themes, slidy, g5, csss, deck.js, impress.js)

EXAMPLES
    slideshow install impress.js
    slideshow install https://raw.github.com/.../impress.js.txt

new Command

NAME
    new - Generate quick starter sample

SYNOPSIS
    slideshow [global options] new [command options] 

COMMAND OPTIONS
    -o, --output=PATH       - Output Path (default: .)
    -t, --template=MANIFEST - Template Manifest (default: welcome)

EXAMPLES
    slideshow new
    slideshow new -t impress.js

INSTALL

Just install the gem:

$ gem install slideshow

QUESTION? COMMENTS?

Send them along to the Free Web Slide Show Alternatives (S5, S6, S9, Slidy And Friends) Forum/Mailing List. Thanks!

LICENSE

The slideshow scripts and templates are dedicated to the public domain. Use it as you please with no restrictions whatsoever.

Something went wrong with that request. Please try again.