Create slides with markdown
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
bin
docs
examples
features
files
lib Updating CHANGELOG, version, .gemspec for 3.8.0 Jun 21, 2017
rakelib
spec
.gitignore
.gitmodules [files-refactor] Moved 'reveal.js' to 'files/reveal.js' Jun 15, 2014
.rspec [spec] Accidentally switched away from "progress" Sep 26, 2013
.rubocop.yml
.ruby-gemset
.ruby-version
.travis.yml
CHANGELOG.md
Gemfile
LICENSE
README.md
Rakefile
reveal-ck.gemspec

README.md

Create Slides with Markdown

reveal-ck is..

a command line tool that helps you author reveal.js presentations.

It lets you focus on the content of your presentation by taking care of the details of building a reveal.js presentation.

You write your presentation in markdown, in a single file, and reveal-ck generates everything else.

Get Started Now

Here's a quick example so you can see what using reveal-ck is like.

Learning More

There are many, many things you can do to customize your slides!

Here's a long, but not exhaustive, list of things you can do:

  • Get fast feedback with LiveReload. Save your slides and instantly see the result.
  • Host your slides up on Github Pages.
  • Use any emoji available on github, such as :money_with_wings:
  • Take advantage of reveal.js' vertical slides
  • Use Github Flavored Markdown Tables
  • Write your slides in HTML or popular Ruby templating languages, like ERB and Haml, and Slim.
  • Easily support CSS tweaks.
  • Use @mentions, such as, @jedcn.
  • Manage configuration of themes and plugins in a single config file.
  • Integrate with rake (ie: create rake tasks that build slides)

Installation

reveal-ck is delivered as a RubyGem, and so, you need Ruby 2.0+ and then installing should be as easy as:

gem install reveal-ck

Verify that things are functional and you have the latest version of reveal-ck by typing:

reveal-ck --version

Questions?

Not everything is documented, and nothing is perfect, so-- if you'd like to ask a question or log a bug please do so!

Contributing

Gem Version Build Status Code Climate Test Coverage

If you're a ruby developer and you want to get going with local development, please see .github/CONTRIBUTING.md.