asciidoctor-revealjs 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 055ddf04cfd1adacd71a163e674cbb6fa2171506
-  data.tar.gz: beac41015126c16206cd999af5173ccc6fe1be19
+  metadata.gz: 59739308d6f926a43ca556691f89c0c06cd59ab9
+  data.tar.gz: d410a0166013bfa61371c43e82e9b2f37a637b62
 SHA512:
-  metadata.gz: 3ef70eb8103ebceff21ed91c8a4a1816cf5fcaf110a29b706a9fdde87161a09cbcfdca31a6c07a29543f0f10c8b7f87c2c00f12e95e0400e7a0c72a3b44ecd55
-  data.tar.gz: bbb86e656baa1ecb60f9197723e67012c50f6feec54b5280c1e9640079c8b9dd3acf25c850339f1746fe9d1e569e5d544dc2df84e0607445d189db91b7dcb126
+  metadata.gz: bfbb7fa08fe665d55fe51f8594b4472c2831e7187474292755336bd85dff269b6c532b82bb905ce23e66b9c526aa550c2acecba529d16b2ae3fe44841aa30a24
+  data.tar.gz: 7ecb489607db5f527ae2fa1f60ed1ae4edb2104581a33d6cb1151906d9f134622af48917a83b1e71795611b4a2c4bbbbee3e9467148b51cfeba87a26ad8e5808

data/CHANGELOG.adoc

@@ -6,21 +6,52 @@
 This document provides a high-level view of the changes introduced in {project-name} by release.
 For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub.
 
-== 1.0.4 (2017-09-27) - @obilodeau
+== 1.1.0 (2017-12-25) - @obilodeau
 
-Bug fixes::
-  * Dependency problems leading to crashes when used from Asciidoctor.js ({uri-issue}145[#145])
-
-////
 Enhancements::
-  * item
+  * Support for Reveal.JS 3.5.0+ ({uri-issue}146[#146], {uri-issue}151[#151])
+  * Support for Asciidoctor 1.5.6 ({uri-issue}132[#132], {uri-issue}136[#136], {uri-issue}142[#142])
+  * Support for Asciidoctor.js 1.5.6-preview.4 ({uri-issue}130[#130], {uri-issue}143[#143], {uri-issue}156[#156])
+  * Compiling slim templates to Ruby allows us to drop Jade templates for Asciidoctor.js users
+    ({uri-issue}63[#63], {uri-issue}131[#131])
+  * Documentation polish ({uri-issue}153[#153], {uri-issue}158[#158] and more)
 
 Compliance::
-  * item
+  * Users of Asciidoctor (Ruby) and Asciidoctor.js (Javascript) now run the same set of templates meaning that we achieved feature parity between the two implementations
+    ({uri-issue}63[#63], {uri-issue}131[#131])
+
+Bug fixes::
+  * Reveal.js https://github.com/hakimel/reveal.js/#configuration[history feature] now works.
+    We are working around Reveal.js' section id character limits.
+    ({uri-issue}127[#127], {uri-issue}150[#150], https://github.com/hakimel/reveal.js/issues/1346[hakimel/reveal.js#1346])
 
 Infrastructure::
-  * item
-////
+  * https://github.com/asciidoctor/asciidoctor-doctest[Asciidoctor-doctest] integration.
+    This layer of automated testing should help prevent regressions and improve our development process.
+    ({uri-issue}92[#92], {uri-issue}116[#116])
+  * Travis-CI integration to automatically run doctests and examples AsciiDoc conversions
+  * Travis-CI tests are triggered by changes done in Asciidoctor.
+    We will detect upstream changes affecting us sooner.
+  * Smoke tests for our Javascript / Node / Asciidoctor.js toolchain (integrated in Travis-CI also)
+  * `npm run examples` will convert all examples using the Javascript / Node / Asciidoctor.js toolchain ({uri-issue}149[#149])
+  * `rake examples:serve` will run a Web server from `examples/` so you can preview rendered examples ({uri-issue}154[#154])
+
+=== Release meta
+
+{uri-repo}/releases/tag/v1.1.0[git tag] |
+{uri-repo}/compare/v1.0.4...v1.1.0[full diff]
+
+=== Credits
+
+Thanks to the following people who contributed to this release:
+
+@jirutka, Dan Allen, Guillaume Grossetie, Jacob Aae Mikkelsen, Olivier Bilodeau, Rahul Somasunderam
+
+
+== 1.0.4 (2017-09-27) - @obilodeau
+
+Bug fixes::
+  * Dependency problems leading to crashes when used from Asciidoctor.js ({uri-issue}145[#145])
 
 === Release meta
 

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in asciidoctor-revealjs.gemspec
+gemspec

data/HACKING.adoc

@@ -6,7 +6,6 @@ Short instructions that aim to help potential contributors.
 
 == Inspect the template system
 
-
 To understand what you have access to in templates you can inject some ruby.
 With the slim templating system, this is done by prepending the lines with a dash (`-`) and inserting a ruby statement.
 Two complementary approaches can be used to explore the context offered by asciidoctor through the template system:
@@ -14,6 +13,16 @@ Two complementary approaches can be used to explore the context offered by ascii
 * logging on the command line via print-like statements
 * jump into the context through an interactive debugger
 
+[NOTE]
+--
+Starting with v1.1.0 the slim templates are compiled to Ruby in order to
+use the same templates from Asciidoctor.js (Javascript / Node.js ecosystem).
+Don't forget to recompile the templates if you make changes to them.
+This can be done by running:
+
+    bundle exec rake build
+--
+
 === Print debugging information
 
 For example to see which attributes are available, you can print them by adding these lines in the `.slim` file of interest:
@@ -45,7 +54,7 @@ It is very useful to discover a complex object hierarchy like what asciidoctor o
 
 ==== Initial Setup
 
-    gem install pry
+    bundle --path=.bundle/gems --binstubs=.bundle/.bin
 
 ==== Usage
 
@@ -56,11 +65,10 @@ In order to be dropped into the debugger at a specific point in a template simpl
 - binding.pry
 ----
 
-Then run asciidoctor from the command-line to generate your document and you'll be dropped in the debugger:
+Then run `asciidoctor-revealjs` from the command-line to generate your document and you'll be dropped in the debugger:
 
 ----
-$ make
-asciidoctor -T templates/slim -b revealjs test/level-sections.adoc
+$ bundle exec asciidoctor-revealjs examples/video.adoc
 asciidoctor: WARNING: level-sections.adoc: line 29: section title out of sequence: expected level 2, got level 3
 
 From: /home/olivier/src/asciidoc/asciidoctor-reveal.js/templates/slim/section.html.slim @ line 3 :
@@ -85,16 +93,27 @@ You can also query asciidoctor's documentation:
 
     [4] pry(#<Asciidoctor::Section>)> ? find_by
 
+If you install the `pry-byebug` gem you get additional debugging capabilities.
+See the gem's documentation for details.
+
+Since 1.1.0, templates are compiled. It is easier to inject the debug
+triggering statements and use the templates directly instead of debugging
+compiled templates. You can call the slim templates directly with:
+
+// TODO it's still not clear whether `-r slim-htag` is required right now (#153)
+
+    bundle exec asciidoctor --trace -T templates/ examples/customcss.adoc
+
 === References
 
 * https://github.com/asciidoctor/asciidoctor.org/issues/80#issuecomment-145698579
 * http://pryrepl.org/
 * http://discuss.asciidoctor.org/Interactively-debugging-a-template-with-a-REPL-td4498.html
 
-== Tests
+== Manual Tests
 
 In order to help troubleshoot issues and test syntax improvements, some minimalist asciidoc test files are provided.
-You can render the tests files and then load them in a browser and check if `asciidoctor-reveal.js` behaves as expected.
+You can render the tests files and then load them in a browser and check if `asciidoctor-revealjs` behaves as expected.
 
 === Initial Setup
 
@@ -103,42 +122,29 @@ done with `bundler`:
 
     bundle config --local github.https true
     bundle --path=.bundle/gems --binstubs=.bundle/.bin
+    bundle exec rake build
 
-Go to `test/` folder and install `reveal.js`:
+Go to `test/output/slim/` folder and install `reveal.js`:
 
-    cd test/
+    cd test/output/slim/
     git clone https://github.com/hakimel/reveal.js.git
 
 === Render tests into .html
 
 From the project's root directory:
 
-    make
+    bundle exec rake generate FORCE=yes
 
 === Open rendered files
 
-You can open the generated `.html` in a Web browser.
-For convenience the following command will open the last modified file:
-
-    make open
-
-Additionally, if you want to test with a minimalist web server:
-
-    make serve
-
-The server is running in the foreground and needs `Ctrl-C` to be killed.
+NOTE: Right now, https://github.com/asciidoctor/asciidoctor-doctest/issues/12[doctest issue #12] means that the generated examples will not be pretty.
 
-== Jade templates
+You can open the generated `.html` in `test/output/slim/` in a Web browser.
 
-Jade templates are used by AsciidocFX. Since they are separate they might be
-out of sync with our asciidoctor's slim templates.
 
-To test the jade templates, install AsciidocFX and copy the jade templates
-over to AsciidocFX's `conf/slide/templates/revealjs/` directory. Then use
-AsciidocFX to render the slides.
+== Asciidoctor API's gotchas
 
-
-== Attribute inheritence
+=== Attribute inheritence
 
 The attr and attr? methods inherit by default. That means if they don't find the attribute defined on the node, they look on the document.
 
@@ -199,30 +205,55 @@ You can apply that label to a pull request that is complete and ready for review
 
 Makes triaging easier.
 
-
 == Node package
 
 === Test a local asciidoctor-reveal.js version
 
-In order to test the Node package, you need to create a test project adjacent to the clone of the `asciidoctor-reveal.js` repository:
+In order to test the Node package, you first need to build the converter into Javascript and create a tarball of the project.
+
+  $ bundle exec rake build:converter:opal
+  $ npm run build
+  $ npm pack
+
+That last command will produce a file named `asciidoctor-reveal.js-<version>.tgz` in the working directory.
+
+Then, create a test project adjacent to the clone of the [.path]_asciidoctor-reveal.js_ repository:
 
  $ mkdir test-project
  $ cd test-project
 
-Now, install the dependencies.
+Now, install the dependencies from the tarball:
+
+ $ npm i --save ../asciidoctor-reveal.js/asciidoctor-reveal.js-<version>.tgz
+
+NOTE: The relative portion of the last command is where you are installing the local `asciidoctor-reveal.js` version from.
+
+Then proceed as documented in the `README.adoc`.
+
+=== Upgrade Asciidoctor.js version
 
-WARNING: It is important to track `Asciidoctor.js`, `Asciidoctor-template.js` and `bestikk-opal-compiler` versions all together.
+WARNING: It is important to track `Asciidoctor.js` and `bestikk-opal-compiler` versions together.
 The `opal-compiler` used to compile our node package must match `asciidoctor.js` `opal-runtime`.
-The first one is explicitly installed by users on install and the two later are specified in our `package.json`.
-When you update one remember to update the others.
+The former is explicitly installed by users on install and the later is specified in our `package.json`.
+When you update one remember to update the other.
 Versions known to work together can be found here, just replace <tag> with the `asciidoctor.js` release you are interested in: https://github.com/asciidoctor/asciidoctor.js/blob/<tag>/package.json
 
- $ npm i --save asciidoctor.js@1.5.5-5
- $ npm i --save ../asciidoctor-reveal.js
+== RubyGem package
 
-NOTE: The relative portion of the last command is where you are installing the local `asciidoctor-reveal.js` version from.
+=== Test a local asciidoctor-revealjs version
 
-Then proceed as documented in the `README.adoc`.
+Compile the converter:
+
+  $ bundle exec rake build
+
+In a clean directory besides the `asciidoctor-reveal.js` repository, create the following `Gemspec` file:
+
+  source 'https://rubygems.org'
+  gem 'asciidoctor-revealjs', :path => '../asciidoctor-reveal.js'
+
+Then run:
+
+  $ bundle --path=.bundle/gems --binstubs=.bundle/.bin
 
 
 == Release process
@@ -242,20 +273,54 @@ Then proceed as documented in the `README.adoc`.
 . Make a release on github (from changelog and copy from previous releases)
 . Pushing the gem on rubygems.org:
 +
+ $ bundle exec rake build
  $ gem build asciidoctor-revealjs.gemspec
  $ gem push asciidoctor-revealjs-X.Y.Z.gem
 
 . Check that the new version is available on https://rubygems.org/gems/asciidoctor-revealjs[rubygems.org]
+. Generate a compatible version of the Ruby converter (using opal mode)
++
+ $ bundle exec rake build:converter:opal
+
 . Build the node package (make sure you have `devDependencies` installed with: `npm install`):
 +
  $ npm run build
 
 . Publish the node package on npm:
 +
- $ npm login
+ $ npm login # only required if not already authenticated
  $ npm publish
 
 . Check that the new version is available on https://www.npmjs.com/package/asciidoctor-reveal.js[npmjs.com]
 . Update version in `lib/asciidoctor-revealjs/version.rb` and `package.json` (+1 bugfix and append '-dev') and commit
 ** commit msg: Begin development on next release
+. Submit a PR upstream to sync the documentation on asciidoctor.org
+** Modify this page: https://github.com/asciidoctor/asciidoctor.org/edit/master/docs/asciidoctor-revealjs.adoc
+
+== Ruby and asciidoctor-doctest tests
+
+=== Running tests
+
+We recommend tests to be run with a fresh install of all dependencies in a local folder that won't affect your ruby install (a `.bundle/` in this directory):
+
+    bundle --path=.bundle/gems --binstubs=.bundle/.bin
+
+Then you can execute the tests with:
+
+    bundle exec rake doctest
+
+However, if you have all dependencies properly installed this command should run the tests successfully:
+
+    rake doctest
+
+=== Generating HTML test target
+
+Tests were bootstrapped by https://github.com/asciidoctor/asciidoctor-doctest/#generate-examples[generating them from asciidoctor-doctest's test corpus] and current asciidoctor-revealjs' slim template engine.
+This is done using the following command:
+
+    bundle exec rake doctest:generate FORCE=y
+
+=== Custom tests
 
+Files in the `examples/` directory are used as tests.
+Resulting slides are kept in `test/doctest/`.

data/LICENSE.adoc

@@ -1,6 +1,6 @@
 .The MIT License
 ....
-Copyright (C) 2012-2016 Olivier Bilodeau, Charles Moulliard, Dan Allen and the Asciidoctor Project
+Copyright (C) 2012-2017 Olivier Bilodeau, Charles Moulliard, Dan Allen and the Asciidoctor Project
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.adoc

@@ -5,6 +5,7 @@ ifdef::env-github,env-browser[]
 :toclevels: 2
 endif::[]
 ifdef::env-github[]
+:branch: master
 :status:
 :outfilesuffix: .adoc
 :!toc-title:
@@ -22,6 +23,7 @@ endif::[]
 :uri-nodejs-download: https://nodejs.org/en/download/
 
 ifdef::env-github[]
+image:https://travis-ci.org/asciidoctor/asciidoctor-reveal.js.svg?branch=master[Build Status,link=https://travis-ci.org/asciidoctor/asciidoctor-reveal.js]
 image:http://img.shields.io/gem/v/asciidoctor-revealjs.svg[gem, link=https://rubygems.org/gems/asciidoctor-revealjs]
 image:http://img.shields.io/npm/v/asciidoctor-reveal.js.svg[npm, link=https://www.npmjs.org/package/asciidoctor-reveal.js]
 endif::[]
@@ -29,14 +31,21 @@ endif::[]
 // IMPORTANT: Changes made to this description should be sync'ed with the readme field in package.json.
 {uri-project-repo}[Asciidoctor reveal.js] is a converter for {uri-asciidoctor}[Asciidoctor] and {uri-asciidoctorjs}[Asciidoctor.js] that transforms an AsciiDoc document into an HTML5 presentation designed to be executed by the {uri-revealjs-home}[reveal.js] presentation framework.
 
-//image:https://travis-ci.org/asciidoctor/asciidoctor-reveal.js.svg?branch=master[Build Status,link=https://travis-ci.org/asciidoctor/asciidoctor-reveal.js]
 
 There are two main technology stacks that can transform AsciiDoc into HTML5 / reveal.js:
 
-* Asciidoctor / Ruby / Slim / Bundler (See <<Ruby Setup>>)
-* Asciidoctor.js / JavaScript / Jade / Node.js (See <<Node / JavaScript Setup>>)
+* Asciidoctor / Ruby / Bundler (See <<Ruby Setup>>)
+* Asciidoctor.js / JavaScript (Node.js) / NPM (See <<Node / JavaScript Setup>>)
 
-Right now the Ruby / Slim templates are more featureful but that is changing quickly.
+Right now the Asciidoctor / Ruby stack is the better tested one but with the changes in v1.1.0 they have feature parity.
+
+ifeval::['{branch}' == 'master']
+NOTE: You're viewing the documentation for the upcoming release.
+If you're looking for the documentation for an older release, please refer to one of the following branches: +
+{uri-project-repo}/tree/maint-1.0.x#readme[1.0.x]
+&hybull;
+{uri-project-repo}/tree/reveal.js-2.x#readme[Unversioned pre-release] (compatible with RevealJS 2.x)
+endif::[]
 
 
 == Ruby Setup
@@ -48,8 +57,6 @@ For a quick start clone our https://github.com/obilodeau/presentation-revealjs-s
 
 For more complete instructions, read on.
 
-NOTE: If you want to use reveal.js 2, please clone the asciidoctor-reveal.js repo and switch to the reveal.js-2.x branch.
-
 
 === Prerequisites
 
@@ -82,7 +89,6 @@ NOTE: These instructions should be repeated for every presentation project.
 source 'https://rubygems.org'
 
 gem 'asciidoctor-revealjs' # latest released version
-#gem 'asciidoctor-revealjs', github: 'asciidoctor/asciidoctor-reveal.js' # github master branch
 ----
 +
 NOTE: For some reason, when you use the system Ruby on Fedora, you also have to add the json gem to the Gemfile.
@@ -95,13 +101,13 @@ NOTE: For some reason, when you use the system Ruby on Fedora, you also have to
 . Optional: Copy or clone reveal.js presentation framework.
   Allows you to modify themes or view slides offline.
 
-  $ git clone -b 3.3.0 --depth 1 https://github.com/hakimel/reveal.js.git
+  $ git clone -b 3.6.0 --depth 1 https://github.com/hakimel/reveal.js.git
 
 
 === Rendering the AsciiDoc into slides
 
 . Create content in a file (*.adoc, *.ad, etc.).
-  See examples in <<Syntax Examples>> section to get started or look at files in `test/`.
+  See examples in <<Syntax Examples>> section to get started.
 
 . Generate HTML presentation from the AsciiDoc source
 
@@ -120,7 +126,6 @@ First you must install and configure {uri-nodejs-download}[Node.js] on your mach
 
 Using npm:
 
- $ npm i --save asciidoctor.js@1.5.5-5
  $ npm i --save asciidoctor-reveal.js
 
 === Rendering the AsciiDoc into slides
@@ -133,14 +138,12 @@ Here we are converting a file named `presentation.adoc` into a reveal.js present
 ----
 // Load asciidoctor.js and asciidoctor-reveal.js
 var asciidoctor = require('asciidoctor.js')();
-var Asciidoctor = asciidoctor.Asciidoctor();
-
 require('asciidoctor-reveal.js');
 
 // Convert the document 'presentation.adoc' using the reveal.js converter
-var attributes = 'revealjsdir=node_modules/reveal.js@';
+var attributes = {'revealjsdir': 'node_modules/reveal.js@'};
 var options = {safe: 'safe', backend: 'revealjs', attributes: attributes};
-Asciidoctor.convertFile('presentation.adoc', options); // <1>
+asciidoctor.convertFile('presentation.adoc', options); // <1>
 ----
 <1> Creates a file named `presentation.html` (in the directory where command is run)
 
@@ -162,19 +165,19 @@ Asciidoctor.convertFile('presentation.adoc', options); // <1>
 
 To render the slides, run:
 
-    node asciidoctor-reveal.js
+    node asciidoctor-revealjs.js
 
 You can open the `presentation.html` file in your browser and enjoy!
 
 
 == Syntax Examples
 
-// FIXME: incomplete
-
 Let's see some examples of `revealjs` backend features.
+Additional examples can be found in the AsciiDoc files (.adoc) in `examples/`.
 
 === Basic presentation with speaker notes
 
+[source, asciidoc]
 ----
 = Title Slide
 
@@ -196,6 +199,18 @@ Actually things aren't that bad
 
 In previous snippet we are creating a slide titled Slide One with bullets and another one titled Slide Two with centered text (reveal.js`' default behavior) with {uri-revealjs-gh}#speaker-notes[speaker notes].
 
+Starting with Reveal.js 3.5 speaker notes supports configurable layouts:
+image:https://cloud.githubusercontent.com/assets/629429/21808439/b941eb52-d743-11e6-9936-44ef80c60580.gif[]
+
+Speaker notes are opened by pressing `s`.
+With Reveal.js 3.5 they require a webserver to work.
+This limitation is not present in 3.6.
+You can get a Web server running quickly with:
+
+    ruby -run -e httpd . -p 5000 -b 127.0.0.1
+
+Then open your browser at: http://localhost:5000/
+
 
 === Slides without titles
 
@@ -207,6 +222,7 @@ There are a few ways to have no titles on slides.
 
 Here is an example of the three techniques in action:
 
+[source, asciidoc]
 ----
 include::test/concealed-slide-titles.adoc[]
 ----
@@ -216,6 +232,7 @@ NOTE: `conceal` and `notitle` have the advantage that the slide still has an id
 
 === Background colors
 
+[source, asciidoc]
 ----
 [background-color="yellow"]
 == Slide Three
@@ -229,6 +246,7 @@ Anything accepted by CSS color formats works.
 
 === Background images
 
+[source, asciidoc]
 ----
 [%notitle]
 == Grand Announcement
@@ -245,6 +263,7 @@ NOTE: Background images file names are now relative to the `:imagedir:` attribut
 
 NOTE: The `canvas` keyword can be used instead of `background` for the same effect.
 
+[source, asciidoc]
 ----
 [%notitle]
 == The Great Goat
@@ -260,6 +279,7 @@ As you can see, you can use a URL to specify your image resource too.
 
 A background video for a slide can be specified using the `background-video` element attribute.
 
+[source, asciidoc]
 ----
 [background-video="https://my.video/file.mp4",background-video-loop=true,background-video-muted=true]
 == Nice background!
@@ -269,6 +289,7 @@ For convenience `background-video-loop` and `background-video-muted` attributes
 
 For example:
 
+[source, asciidoc]
 ----
 [background-video="https://my.video/file.mp4",options="loop,muted"]
 == Nice background!
@@ -282,6 +303,7 @@ Note that the `data-` prefix is not required in asciidoc files.
 
 The background can be replaced with anything a browser can render in an iframe using the `background-iframe` reveal.js feature.
 
+[source, asciidoc]
 ----
 [%notitle,background-iframe="https://www.youtube.com/embed/LaApqL4QjH8?rel=0&start=3&enablejsapi=1&autoplay=1&loop=1&controls=0&modestbranding=1"]
 == a youtube video
@@ -292,6 +314,7 @@ See {uri-revealjs-gh}#iframe-backgrounds[the relevant reveal.js documentation] f
 
 === Slide Transitions
 
+[source, asciidoc]
 ----
 [transition=zoom, %notitle]
 == Zoom zoom
@@ -309,6 +332,7 @@ See {uri-revealjs-gh}#slide-transitions[the relevant reveal.js documentation] fo
 
 === Fragments
 
+[source, asciidoc]
 ----
 == Slide Four
 
@@ -346,6 +370,7 @@ See {uri-revealjs-gh}#stretching-elements[reveal.js documentation on stretching
 In addition to <<Background videos,background videos>>, videos can be inserted directly into slides.
 The syntax is the standard http://asciidoctor.org/docs/user-manual/#video[asciidoc video block macro] syntax.
 
+[source, asciidoc]
 ----
 == Trains, we love trains!
 
@@ -358,12 +383,13 @@ To override that behavior use the `width` and `height` named attributes.
 
 === Syntax highlighting
 
-[listing]
+[source, asciidoc]
 ....
 == Slide Five
 
 Uses highlighted code
 
+[source, python]
 ----
 print "Hello World"
 ----
@@ -375,7 +401,7 @@ An explicit `[listing]` block will not be highlighted.
 `highlight.js` does language auto-detection but using the `language="..."` attribute will hint the highlighter.
 For example this will highlight this source code as Perl:
 
-[listing]
+[source, asciidoc]
 ....
 == Slide Five
 
@@ -394,6 +420,7 @@ These handle callouts correctly.
 
 To use http://coderay.rubychan.de[Coderay]:
 
+[source, asciidoc]
 ----
 = Title slide
 :source-highlighter: coderay
@@ -401,6 +428,7 @@ To use http://coderay.rubychan.de[Coderay]:
 
 To use http://pygments.org[Pygments]:
 
+[source, asciidoc]
 ----
 = Title slide
 :source-highlighter: pygments
@@ -408,7 +436,7 @@ To use http://pygments.org[Pygments]:
 
 === Vertical slides
 
-[listing]
+[source, asciidoc]
 ....
 == Slide Six
 
@@ -442,6 +470,7 @@ Keep in mind that for title slides you must replace `data-` with
 
 Here is an example:
 
+[source, asciidoc]
 ----
 include::test/title-slide-image.adoc[]
 ----
@@ -462,6 +491,7 @@ In the end, the whole document has to be compiled with the backend option:
 
 For example:
 
+[source, asciidoc]
 ----
 == Main section
 
@@ -494,6 +524,7 @@ Doing so, you can then easily override specific elements of your theme per prese
 
 For example, to do proper position-independent text placement of a title slide with a specific background you can use:
 
+[source, css]
 ----
 .reveal section.title h1 {
     margin-top: 2.3em;
@@ -514,6 +545,7 @@ If the `:customcss:` attribute value is empty then `asciidoctor-revealjs.css` is
 Reveal.js supports a {uri-revealjs-gh}#slide-states[data-state] tag that can be added on slides which gets rendered into `<section>` tags.
 In AsciiDoc the `data-state` can be applied to a slide by adding a state attribute to a section like this:
 
+[source, asciidoc]
 ----
 [state=topic]
 == Epic Topic
@@ -522,6 +554,7 @@ In AsciiDoc the `data-state` can be applied to a slide by adding a state attribu
 That state can be queried from Javascript or used in CSS to apply further customization to your slide deck.
 For example, by combining this feature with the <<CSS override>> one, you can alter fonts for specific pages with this CSS:
 
+[source, css]
 ----
 @import 'https://fonts.googleapis.com/css?family=Baloo+Bhai';
 
@@ -536,12 +569,14 @@ section[data-state="topic"] h2 {
 Asciidoctor font-based http://asciidoctor.org/docs/user-manual/#admonition[admonitions] are supported.
 Make sure to add the following attribute to your document:
 
+[source, asciidoc]
 ----
 :icons: font
 ----
 
 Here is an example slide:
 
+[source, asciidoc]
 ----
 == But first
 
@@ -551,11 +586,6 @@ WARNING: This presentation is dangerous!
 Here are details about Asciidoctor's http://asciidoctor.org/docs/user-manual/#admonition-icons[Admonition icons] support.
 
 
-// FIXME this is no longer accurate
-== About Jade Templates
-
-`/templates/jade` directory contains jade template files they are ported from `/templates/slim` templates. These templates were written to support the reveal.js converter for Asciidoctor.js environment that is currently using in https://github.com/asciidocfx/AsciidocFX[AsciidocFX] editor. You can look at the https://github.com/asciidocfx/asciidoctor.js-reveal-demo[demo].
-
 == Reveal.js Options
 
 There are some attributes that can be set at the top of the document which they are specific of `revealjs` converter.
@@ -691,11 +721,11 @@ activate it.
 
 == Minimum Requirements
 
-* asciidoctor 1.5.4
+* asciidoctor 1.5.6
 
 == Copyright and Licensing
 
-Copyright (C) 2012-2016 {authors} and the Asciidoctor Project.
+Copyright (C) 2012-2017 {authors} and the Asciidoctor Project.
 Free use of this software is granted under the terms of the MIT License.
 
 ifdef::env-github,env-browser[See the <<LICENSE#,LICENSE>> file for details.]