How do I install slideshow on my system?

Install it via RubyGems with 'gem install slideshow'. Ensure Ruby is installed first—check the Ruby website for setup instructions based on your OS. This CLI approach is straightforward for developers familiar with command-line tools.

Can I use slideshow with my existing Markdown files?

Yes, slideshow processes plain text files with Markdown conventions, so you can repurpose existing documentation. However, you may need to adjust formatting to match slide breaks or template requirements.

What templates are available and how do I use them?

Templates include reveal.js, impress.js, deck.js, and others from the slideshow-templates GitHub org. Use them by specifying the template in the CLI command, but note that setup might require downloading or configuring themes separately.

How does slideshow compare to using Pandoc for presentations?

Slideshow is Ruby-based and focused on a CLI workflow with specific templates, while Pandoc is a universal document converter supporting more formats but less tailored for slide decks. Slideshow is simpler for dedicated presentation generation but less flexible for mixed document types.

How to add images or custom styling in slideshow?

Use standard Markdown syntax for images and inline HTML/CSS in your text files. For advanced styling, modify or create custom templates in the modular architecture, which requires knowledge of the underlying framework like reveal.js.

Is slideshow suitable for non-technical team members?

No, its reliance on command-line tools, text editing, and potential need for Ruby knowledge makes it best for developers or technical users. Non-technical presenters might find GUI tools like PowerPoint more accessible.

Open-Awesome

Slide Show (S9)

CC0-1.0Ruby

A command-line tool for creating presentations from plain text using Markdown formatting conventions.

GitHub

189 stars22 forks0 contributors

What is Slide Show (S9)?

Slideshow is a Ruby gem and command-line tool that lets developers create presentations by writing plain text with Markdown formatting conventions. It generates slide decks from text files, providing a code-friendly alternative to traditional presentation software. The tool supports various templates and themes for different presentation styles and frameworks.

Target Audience

Developers, technical presenters, and anyone who prefers writing content in plain text and wants to version-control their presentations like code.

Value Proposition

Slideshow offers a lightweight, text-based workflow that integrates with developer tools and version control systems, unlike heavyweight GUI presentation software. It's completely free with a public domain license and supports multiple presentation frameworks through its template system.

Overview

slideshow gems - write your slides / talks / presentations in plain text with markdown formatting conventions

Use Cases

Best For

Creating technical presentations with code snippets
Version-controlling presentation content alongside project code
Generating slide decks from existing Markdown documentation
Automating presentation generation in build pipelines
Creating consistent presentations using reusable templates
Presenters who prefer editing text over using GUI tools

Not Ideal For

Teams needing real-time collaborative editing or cloud-based presentation tools
Presenters who require advanced animations, transitions, or multimedia integration beyond basic slides
Projects in environments without Ruby or where adding a Ruby dependency is prohibitive

Pros & Cons

Pros

Plain Text Workflow

Slides are written in Markdown, enabling version control with Git and editing in any text editor, which seamlessly integrates into developer toolchains.

Template Flexibility

Supports multiple JavaScript presentation frameworks like reveal.js and impress.js through its template system, allowing diverse slide deck styles without locking into one format.

Command-Line Automation

The CLI tool generates presentations from text files, making it easy to automate in build pipelines or scripts for consistent, repeatable output.

Public Domain License

Completely free with no restrictions, ideal for open-source projects or commercial use without licensing overhead or legal concerns.

Cons

Sparse Documentation

The README is minimal, lacking detailed tutorials or examples, which can make initial setup and advanced usage challenging without external resources.

Ruby Dependency Overhead

Requires Ruby and gem installation, adding complexity for teams not already using Ruby or in environments where managing Ruby dependencies is cumbersome.

Limited Design Tools

Relies on templates for styling, so creating custom visual designs or interactive elements requires manual CSS/JS work, unlike GUI-based presentation software.

Open Source Alternative To

Slide Show (S9) is an open-source alternative to the following products:

Keynote

Keynote is Apple's presentation software included in the iWork suite, used for creating slideshows with animations, transitions, and multimedia elements on macOS and iOS devices.

PowerPoint

PowerPoint is a presentation program developed by Microsoft as part of the Microsoft Office suite, used to create slideshows with text, images, animations, and multimedia.

Google Slides

Google Slides is a web-based presentation program that allows users to create, edit, and collaborate on slideshows in real-time as part of Google Workspace.

Frequently Asked Questions

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub