Skip to content

Commit

Permalink
minimal README for reveal.js back-end (hakimel#49)
Browse files Browse the repository at this point in the history
  • Loading branch information
obilodeau committed Sep 21, 2014
1 parent c25ef81 commit bf57376
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
== reveal.js Backend

The https://github.com/asciidoctor/asciidoctor-backends/tree/master/slim/revealjs[reveal.js
backend] is a collection of slim templates which transform an AsciiDoc
document to HTML5 slides animated by http://lab.hakim.se/reveal-js/[reveal.js].

=== Installation

First, you should download (or git clone) the
https://github.com/asciidoctor/asciidoctor-backends[asciidoctor-backends]
repository to a convenient location.

git clone git://github.com/asciidoctor/asciidoctor-backends.git

Then from your working directory (that is where your AsciiDoc document
resides) you must create a +reveal.js+ directory and copy there the +reveal.js+
file with its directories (plugin, css, ...). You could also just clone
the [reveal.js] repository.

git clone git://github.com/hakimel/reveal.js.git

=== Rendering

First, make sure Asciidoctor is installed:

gem install asciidoctor

Then, to render your presentation as HTML5, simply execute the command:

asciidoctor -T <backend directory> <asciidoc file>

So for the above revealjs backend you'd use

asciidoctor -T <base>/asciidoctor-backends/slim/revealjs <asciidoc file>

0 comments on commit bf57376

Please sign in to comment.