asciidoctor-revealjs 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5368399f156f92de3794d4919d8fc0740fbec78d
-  data.tar.gz: 3ad253db3e4038170b061836a8fe4c27c35fd674
+  metadata.gz: 14b2dd8f11550942b75a46297e1be232d179fc0a
+  data.tar.gz: 86e9d3aff792a1c83b57bd0ecbb7677680b44308
 SHA512:
-  metadata.gz: dd3c0ec294a8b66ad5cf1d761642d30b8b461a1a4f54e8021997dd0a7960f82afdf0a780f576b1680188e3bda89693c6dfcdf64b131addd98ec1c17e7adce937
-  data.tar.gz: b44326137fc221a903834d047254c34b30d335d263913e12e9fb77618e5bbaca0f298aab8be8374f54ffdae926b8ede32c51e045a13caba701bc78002e91cb2d
+  metadata.gz: 7bb80a495ef1343f0138230c39f7f50d62ef605030649305383bf3962a10a7a8f76cb5eca90403bd35d03f266d60ef941b2ba764bde8922f25f573211f76bac3
+  data.tar.gz: 77b81ec739da0c63e5746cd1d6e7f9eb93b2090ff4e28ad4d7c5ea1b4e219db0bda344de1c675a3746ba6e0464b273e609b343627356f4d2654f35e61c4b67b5

data/CHANGELOG.adoc

@@ -5,11 +5,10 @@
 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.1 (2016-10-12) - @obilodeau
+== 1.0.2 (2016-12-22) - @obilodeau
 
 Enhancements::
-  * Documentation: aligned release process for both npm and ruby gems packages
-  * npm package in sync with ruby gem
+  * Ruby back-end is now compiled in Javascript with Opal (#115)
 
 ////
 Compliance::
@@ -22,6 +21,12 @@ Infrastructure::
   * item
 ////
 
+== 1.0.1 (2016-10-12) - @obilodeau
+
+Enhancements::
+  * Documentation: aligned release process for both npm and ruby gems packages
+  * npm package in sync with ruby gem
+
 == 1.0.0 (2016-10-06) - @obilodeau
 
 Since this is the first ever "release" of asciidoctor-reveal.js (we used to do continuous improvements w/o releases in the past), this list focuses on the major enhancements introduced over the last few weeks.

data/HACKING.adoc

@@ -204,8 +204,7 @@ In order to test the Node package, you need to create a test project adjacent to
 
 Now, install the dependencies:
 
- $ npm i --save asciidoctor.js@1.5.5-2
- $ npm i --save asciidoctor-template.js@1.5.5-2
+ $ npm i --save asciidoctor.js@1.5.5-3
  $ npm i --save ../asciidoctor-reveal.js
 
 NOTE: The relative portion of the last command is where you are installing the local `asciidoctor-reveal.js` version from.
@@ -233,12 +232,16 @@ Then proceed as documented in the `README.adoc`.
  $ gem push asciidoctor-revealjs-X.Y.Z.gem
 
 . Check that the new version is available on https://rubygems.org/gems/asciidoctor-revealjs[rubygems.org]
+. 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 publish
 
 . Check that the new version is available on https://www.npmjs.com/package/asciidoctor-reveal.js[npmjs.com]
-. Update version (+1 bugfix and append '.dev') and commit
+. 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
 

data/README.adoc

@@ -1,27 +1,44 @@
-= reveal.js backend for Asciidoctor
+= Reveal.js converter for Asciidoctor
+Olivier Bilodeau <https://github.com/obilodeau[@obilodeau]>; Guillaume Grossetie <https://github.com/mogztter[@mogztter]>; Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Rahman Usta <https://github.com/rahmanusta[@rahmanusta]>; Charles Moulliard <https://github.com/cmoulliard[@cmoulliard]>
+ifdef::env-github,env-browser[]
 :toc: preamble
 :toclevels: 2
-:uri-us: https://github.com/asciidoctor/asciidoctor-reveal.js
+endif::[]
+ifdef::env-github[]
+:status:
+:outfilesuffix: .adoc
+:!toc-title:
+:caution-caption: :fire:
+:important-caption: :exclamation:
+:note-caption: :paperclip:
+:tip-caption: :bulb:
+:warning-caption: :warning:
+endif::[]
+:uri-project-repo: https://github.com/asciidoctor/asciidoctor-reveal.js
 :uri-asciidoctor: https://github.com/asciidoctor/asciidoctor
 :uri-asciidoctorjs: https://github.com/asciidoctor/asciidoctor.js
 :uri-revealjs-home: http://lab.hakim.se/reveal-js/
 :uri-revealjs-gh: https://github.com/hakimel/reveal.js
 :uri-nodejs-download: https://nodejs.org/en/download/
 
-// Changes made here should be sync'ed in packages.json's readme field
-The {uri-us}[reveal.js backend] is a collection of templates for {uri-asciidoctor}[Asciidoctor] (or {uri-asciidoctorjs}[Asciidoctor.js]) that transform an AsciiDoc document into HTML5 slides animated by {uri-revealjs-home}[reveal.js].
+ifdef::env-github[]
+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::[]
+
+// 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:
+There are two main technology stacks that can transform AsciiDoc into HTML5 / reveal.js:
 
-* Asciidoctor / Ruby / Slim / Bundler (<<ruby, instructions here>>)
-* Asciidoctor.js / JavaScript / Jade / Node.js (<<javascript, instructions here>>)
+* Asciidoctor / Ruby / Slim / Bundler (See <<Ruby Setup>>)
+* Asciidoctor.js / JavaScript / Jade / Node.js (See <<Node / JavaScript Setup>>)
 
 Right now the Ruby / Slim templates are more featureful but that is changing quickly.
 
 
-[[ruby]]
 == Ruby Setup
 
 NOTE: asciidoctor-reveal.js is now a Ruby Gem.
@@ -60,6 +77,7 @@ NOTE: These instructions should be repeated for every presentation project.
 
 . Create a file named `Gemfile` with the following content:
 +
+[source,ruby]
 ----
 source 'https://rubygems.org'
 
@@ -92,7 +110,6 @@ NOTE: For some reason, when you use the system Ruby on Fedora, you also have to
 TIP: If you are using https://pages.github.com/[GitHub Pages], plan ahead by keeping your source files on `master` branch and all output files on the `gh-pages` branch.
 
 
-[[javascript]]
 == Node / JavaScript Setup
 
 === Prerequisites
@@ -103,32 +120,27 @@ First you must install and configure {uri-nodejs-download}[Node.js] on your mach
 
 Using npm:
 
- $ npm i --save asciidoctor.js@1.5.5-2
- $ npm i --save asciidoctor-template.js@1.5.5-2
- $ npm i --save asciidoctor-reveal.js@1.5.5-2
+ $ npm i --save asciidoctor.js@1.5.5-3
+ $ npm i --save asciidoctor-reveal.js
 
 === Rendering the AsciiDoc into slides
 
-Once the package is installed, you can convert AsciiDoc files using Reveal.js backend.
-Here we are converting a file named `presentation.adoc` into a Reveal.js presentation using Node.js:
+Once the package is installed, you can convert AsciiDoc files using reveal.js converter.
+Here we are converting a file named `presentation.adoc` into a reveal.js presentation using Node.js:
 
 .asciidoctor-revealjs.js
 [source, javascript]
 ----
-// Load asciidoctor.js + asciidoctor-template.js
+// Load asciidoctor.js and asciidoctor-reveal.js
 var asciidoctor = require('asciidoctor.js')();
 var Asciidoctor = asciidoctor.Asciidoctor();
-var Opal = asciidoctor.Opal;
-Opal.load('nodejs');
-Opal.load('pathname');
-require('asciidoctor-template.js');
 
-// Convert the document 'presentation.adoc' using Reveal.js backend
+require('asciidoctor-reveal.js');
+
+// Convert the document 'presentation.adoc' using the reveal.js converter
 var attributes = 'revealjsdir=node_modules/reveal.js@';
-var options = Opal.hash({safe: 'safe',
-                         backend: 'revealjs',
-                         attributes: attributes});
-Asciidoctor.$convert_file('presentation.adoc', options); // <1>
+var options = {safe: 'safe', backend: 'revealjs', attributes: attributes};
+Asciidoctor.convertFile('presentation.adoc', options); // <1>
 ----
 <1> Creates a file named `presentation.html` (in the directory where command is run)
 
@@ -182,7 +194,7 @@ 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].
+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].
 
 
 === Slides without titles
@@ -225,7 +237,7 @@ image::cover.jpg[background, size=cover]
 ----
 
 This will put `cover.jpg` as the slide's background image.
-It sets `reveal.js'` `data-background-image` attribute.
+It sets reveal.js`' `data-background-image` attribute.
 The `size` attribute is also supported.
 See the {uri-revealjs-gh}#image-backgrounds[relevant reveal.js documentation] for details.
 
@@ -320,9 +332,7 @@ Note that only `fade-in` is supported for lists at the moment.
 Reveal.js supports a special class that will give all available screen space to an HTML node.
 This class element is named `stretch`.
 
-__
 Sometimes it's desirable to have an element, like an image or video, stretch to consume as much space as possible within a given slide.
-__
 
 To apply that class to block simply use asciidoctor's class assignment:
 
@@ -333,7 +343,7 @@ See {uri-revealjs-gh}#stretching-elements[reveal.js documentation on stretching
 
 === Videos
 
-In addition to <<background_videos,background videos>>, videos can be inserted directly into slides.
+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.
 
 ----
@@ -422,7 +432,7 @@ The title slide is customized via Asciidoc attributes.
 These are the global variable assigned at the top of a document under the lead
 title that look like this: `:name: value`.
 
-This back-end supports changing the color, image, video, iframe and
+This converter supports changing the color, image, video, iframe and
 transitions of the title slide.
 
 Read {uri-revealjs-gh}#slide-backgrounds[the relevant
@@ -439,15 +449,15 @@ include::test/title-slide-image.adoc[]
 The title slide is also added a `title` CSS class to help with template
 customization.
 
-=== Content meant for multiple back-ends
+=== Content meant for multiple converters
 
 Some content can be created with both slides and book in mind.
 
 To mark slides split points you can use preprocessor conditionals combined
-with back-end declaration.
+with a backend declaration.
 Breaking points are set using slides with no title `=== !` wrapped in a
 conditional: `ifdef::backend-revealjs[=== !]`.
-In the end, the whole document has to be compiled with the back-end option:
+In the end, the whole document has to be compiled with the backend option:
 `-b revealjs`
 
 For example:
@@ -510,7 +520,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, CSS override>> one, you can alter fonts for specific pages with this CSS:
+For example, by combining this feature with the <<CSS override>> one, you can alter fonts for specific pages with this CSS:
 
 ----
 @import 'https://fonts.googleapis.com/css?family=Baloo+Bhai';
@@ -525,11 +535,11 @@ section[data-state="topic"] h2 {
 // 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 reveal.js backend 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].
+`/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
+== Reveal.js Options
 
-There are some attributes that can be set at the top of the document which they are specific of +revealjs+ backend.
+There are some attributes that can be set at the top of the document which they are specific of `revealjs` converter.
 
 NOTE: Default settings are based on `reveal.js` default settings.
 
@@ -539,7 +549,7 @@ NOTE: Default settings are based on `reveal.js` default settings.
 
 |:revealjs_theme:
 |beige, *black*, league, night, serif, simple, sky, solarized, white
-|Chooses one of reveal.js' {uri-revealjs-gh}#theming[built-in themes].
+|Chooses one of reveal.js`' {uri-revealjs-gh}#theming[built-in themes].
 
 |:revealjs_customtheme:
 |<file\|URL>
@@ -666,7 +676,7 @@ activate it.
 
 == Copyright and Licensing
 
-Copyright (C) 2012-2016 Olivier Bilodeau, Charles Moulliard, Dan Allen and the Asciidoctor Project.
+Copyright (C) 2012-2016 {authors} and the Asciidoctor Project.
 Free use of this software is granted under the terms of the MIT License.
 
-See the <<LICENSE#,LICENSE>> file for details.
+ifdef::env-github,env-browser[See the <<LICENSE#,LICENSE>> file for details.]

data/lib/asciidoctor-revealjs.rb

@@ -1,2 +1,7 @@
-require 'asciidoctor' unless defined? Asciidoctor::Converter
-require_relative 'asciidoctor-revealjs/converter'
+if RUBY_ENGINE == 'opal'
+  require 'asciidoctor-revealjs/converter'
+  `require('asciidoctor-template.js')`
+else
+  require 'asciidoctor' unless defined? Asciidoctor::Converter
+  require_relative 'asciidoctor-revealjs/converter'
+end

data/lib/asciidoctor-revealjs/converter.rb

@@ -1,11 +1,13 @@
-require 'asciidoctor/converter/html5'
-require 'asciidoctor/converter/composite'
-require 'asciidoctor/converter/template'
+unless RUBY_ENGINE == 'opal'
+  require 'asciidoctor/converter/html5'
+  require 'asciidoctor/converter/composite'
+  require 'asciidoctor/converter/template'
+end
 
 module Asciidoctor; module Revealjs
 
   class Converter < ::Asciidoctor::Converter::CompositeConverter
-    ProvidedTemplatesDir = ::File.expand_path '../../../templates', __FILE__
+    ProvidedTemplatesDir = RUBY_ENGINE == 'opal' ? 'node_modules/asciidoctor-reveal.js/templates' : (::File.expand_path '../../../templates', __FILE__)
     register_for 'revealjs'
 
     def initialize backend, opts = {}

data/lib/asciidoctor-revealjs/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
 module Revealjs
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end
 end

data/templates/jade/document.jade

@@ -15,7 +15,7 @@ html(lang=node.document.$attr("lang", "en") )
     if node.$attr("revealjs_customtheme", false)
       link(rel='stylesheet',href="#{node.$attr('revealjs_customtheme')}",id='theme')
     else
-      link(rel='stylesheet',href='#{revealjsdir}/css/theme/serif.css',id='theme')
+      link(rel='stylesheet',href='#{revealjsdir}/css/theme/#{node.$attr("revealjs_theme", "black")}.css',id='theme')
     link(href="#{revealjsdir}/lib/css/zenburn.css",rel="stylesheet")
     script(src = "http://getfirebug.com/firebug-lite.js#startOpened=false")
     script(type='text/javascript').

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-revealjs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Olivier Bilodeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-13 00:00:00.000000000 Z
+date: 2016-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Converts AsciiDoc to HTML for a Reveal.js presentation