asciidoctor-revealjs 2.0.1 → 3.0.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c859d03df98f52ebbcc3e1f379a41c6103e6140a94b253732a8cf5689e098e4
-  data.tar.gz: 2558438a7589d665bd25aae3f49d9b99ca1241a2ff390508380a3a4abe38787a
+  metadata.gz: cfd55df0c713f375e7f6512d1390b06347a742d00eb35cbbc39298de6680cfe3
+  data.tar.gz: 397f8663b1586aa46990f18d21821722762aab12ffb688b1bfa81558c9a2c9e4
 SHA512:
-  metadata.gz: ca517e99129e78868555c180e9464e4d4953a434499cde9c46a018ab17dfbba440bc619282e7e9e4e98270f61b4b93897910e8ca2fa060ab5ee2cdd380d2cef5
-  data.tar.gz: c3f53bfe969e5774ab0947d8db41477d6af5e22217fce08d760bf5c0d70b366663c31cc1543cefd584cd73fbb5e7991f995d7b0237cfd23d835dfb68e502493c
+  metadata.gz: a7ab85893e595375c5ef70bccb4439c4ee159282ba2515931ed55948f92f1b2300a1f5fbe305cbc392531e11f991cb5fbd0a47ee8fcab8e0cb7c80081c1954a9
+  data.tar.gz: 3a034c9c4a4f4e08ac1e9958d417bd9fe6aa50b5ee50ff2334f86bfff85e0b7f1dad630c1c546bcb8f56573032e52554a4245e9995af97cdc744fdb9df8feb43

data/CHANGELOG.adoc

@@ -6,6 +6,57 @@
 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.
 
+== master (unreleased)
+
+Upgrade considerations::
+  * Node.js packaging changes!
+    With the arrival of Asciidoctor.js 2.0.0 you can now use a command line interface (CLI) just like with Asciidoctor Ruby:
+
+    $(npm bin)/asciidoctor -r @asciidoctor/reveal.js -b revealjs presentation.adoc
++
+If you want to keep generating your reveal.js presentations using the Node.js API, you need to change the following code.
+Instead of:
+
+    var asciidoctorRevealjs = require('asciidoctor-reveal.js');
+    asciidoctorRevealjs.register()
++
+Use:
+
+    var asciidoctor = require('@asciidoctor/core')()
+    var asciidoctorRevealjs = require('@asciidoctor/reveal.js')
+    asciidoctorRevealjs.register()
++
+  * Node.js package name changed from `asciidoctor-reveal.js` to `@asciidoctor/reveal.js` ({uri-issue}252[#252], {uri-issue}291[#291])
+  * Custom CSS might require adjustments.
+    Source and listing block encapsulation changed due to our migration to Asciidoctor 2.0.0 Syntax Highlighter API.
+    See {uri-issue}287[#287].
+  * Upgraded to Font-Awesome 5.8.2 from 4.3.0 which contains some backward incompatible changes ({uri-issue}268[#268])
+  * {project-name} now requires Asciidoctor 2.0.0+ or Asciidoctor.js 2.0.0+ ({uri-issue}290[#290])
+  * Dropped support for end-of-life Ruby version 2.1 and 2.2 ({uri-issue}247[#247])
+
+Compliance::
+  * Added support for table frame, grid, header and alignment options ({uri-issue}29[#29], {uri-issue}42[#42], {uri-issue}56[#56], {uri-issue}288[#288])
+  * Added support for Reveal.js data-background-opacity ({uri-issue}269[#269])
+  * Added support for Reveal.js data-background-position ({uri-issue}273[#273], {uri-issue}274[#274])
+
+Enhancements::
+  * Support for Asciidoctor.js 2.0.0+ which brings a command line interface ({uri-issue}254[#254])
+  * Migrated to Asciidoctor 2.0.0 new https://github.com/asciidoctor/asciidoctor/releases/tag/v2.0.0[Syntax Highlighter API] ({uri-issue}261[#261], {uri-issue}287[#287])
+  * Added support for Reveal.js PDF export options ({uri-issue}277[#277])
+  * Upgraded to Font-Awesome 5.8.2 ({uri-issue}268[#268])
+  * We now accept `reveal.js` as converter/backend name in addition to `revealjs` ({uri-issue}253[#253], {uri-issue}297[#297])
+  * Babel integration example API updated to use {project-name} 2.x API ({uri-issue}285[#285])
+  * Node.js package clean-ups ({uri-issue}279[#279], {uri-issue}281[#281], {uri-issue}282[#282])
+  * Upgrade Opal to use a compatible version with Asciidoctor.js 2.0.3 ({uri-issue}289[#289])
+  * Documentation improvements ({uri-issue}292[#292])
+  * Improvements to tests ({uri-issue}294[#294])
+
+Bug Fixes::
+  * Babel integration example updated for security ({uri-issue}285[#285])
+
+Infrastructure::
+  * Updated Travis' JRuby to fix issues with bundler ({uri-issue}295[#295])
+
 
 == 2.0.1 (2019-12-04)
 

data/Gemfile

@@ -2,5 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in asciidoctor-revealjs.gemspec
 gemspec
-# Asciidoctor.js 1.5.9 requires an unreleased Opal 0.11.99.dev (6703d8d)
-gem 'opal', :git => 'https://github.com/opal/opal.git', :ref => '6703d8d'
+# Asciidoctor.js 2.0.0 requires an unreleased Opal 0.11.99.dev (d136ea8)
+gem 'opal', :git => 'https://github.com/opal/opal.git', :ref => 'd136ea8'

data/README.adoc

@@ -21,28 +21,30 @@ endif::[]
 :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/
+:showcasedir: showcase 
 
 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]
+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.
 
+TIP: Want to see some example presentations, see <<Showcase Presentations>>
 
 There are two main technology stacks that can transform AsciiDoc into HTML5 / reveal.js:
 
 * Asciidoctor / Ruby / Bundler (See <<Ruby Setup>>)
-* Asciidoctor.js / JavaScript (Node.js) / NPM (See <<Node / JavaScript Setup>>)
+* Asciidoctor.js / JavaScript (Node.js) / npm (See <<Node / JavaScript Setup>>)
 
 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 an upcoming release.
 If you're looking for the documentation for the current release or an older one, please click on the appropriate link below: +
-{uri-project-repo}/tree/v2.0.0#readme[2.0.0] (latest release)
+{uri-project-repo}/tree/v2.0.1#readme[2.0.1] (latest release)
 &hybull;
 {uri-project-repo}/tree/v1.1.3#readme[1.1.3] (latest from 1.1 series)
 &hybull;
@@ -130,38 +132,43 @@ TIP: If you are using https://pages.github.com/[GitHub Pages], plan ahead by kee
 
 === Prerequisites
 
-First you must install and configure {uri-nodejs-download}[Node.js] on your machine.
+First you must install and configure {uri-nodejs-download}[Node] on your machine.
 
 === Install
 
-Using npm:
+We recommend to install the dependencies in a project directory, such as the directory where your AsciiDoc presentations are stored.
+If you don't have a `package.json` file in your project directory, you can create one to eliminate warnings during the installation using:
 
-Create a directory to place slides. Initialize the directory to store npm packages within that directory. 
+ $ npm init -y
 
- $ echo {} > package.json               # eliminates warnings, use `npm init` if you prefer
- $ npm i --save asciidoctor-reveal.js
+You can now install the dependencies:
 
-=== Rendering the AsciiDoc into slides
+ $ npm i --save asciidoctor @asciidoctor/reveal.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:
+=== Convert AsciiDoc into slides
 
-.asciidoctor-revealjs.js
-[source, javascript]
-----
-// Load asciidoctor.js and asciidoctor-reveal.js
-var asciidoctor = require('asciidoctor.js')();
-var asciidoctorRevealjs = require('asciidoctor-reveal.js');
-asciidoctorRevealjs.register()
+Once the dependencies are installed, verify that the `asciidoctor` command is available.
+On Linux and macOS, open a terminal and type:
 
-// Convert the document 'presentation.adoc' using the reveal.js converter
-var options = {safe: 'safe', backend: 'revealjs'};
-asciidoctor.convertFile('presentation.adoc', options); // <1>
+ $ $(npm bin)/asciidoctor --version
+
+On Windows, open PowerShell and type:
+
+ $ .\node_modules\.bin\asciidoctor.cmd --version
+
+The command should report the Asciidoctor CLI version in the terminal:
+
+[source,console]
+----
+Asciidoctor.js 2.0.3 (Asciidoctor 2.0.9) [https://asciidoctor.org]
+Runtime Environment (node v10.15.1 on linux)
+CLI version 2.0.1
 ----
-<1> Creates a file named `presentation.html` (in the directory where command is run)
+
+If you don't have an existing presentation, you can create a sample presentation named [.path]_presentation.adoc_:
 
 .presentation.adoc
-[source, asciidoc]
+[source,asciidoc]
 ----
 = Title Slide
 
@@ -173,12 +180,40 @@ asciidoctor.convertFile('presentation.adoc', options); // <1>
 
 ----
 
-To render the slides, run:
+To convert the sample presentation into slides, open a terminal and type:
 
-    node asciidoctor-revealjs.js
+ $ $(npm bin)/asciidoctor -r @asciidoctor/reveal.js -b revealjs presentation.adoc
 
-You can open the `presentation.html` file in your browser and enjoy!
+On windows, open PowerShell and type:
+
+ $ .\node_modules\.bin\asciidoctor.cmd -r @asciidoctor/reveal.js -b revealjs presentation.adoc
+ 
+The above command will generate a file named [.path]_presentation.html_.
+You can open this file in a browser.
 
+==== Using the JavaScript API
+
+Alternatively, you can use the JavaScript API to register the converter and convert a document:
+
+.convert-slides.js
+[source,javascript]
+----
+// Load Asciidoctor.js and the reveal.js converter
+var asciidoctor = require('@asciidoctor/core')()
+var asciidoctorRevealjs = require('@asciidoctor/reveal.js')
+asciidoctorRevealjs.register()
+
+// Convert the document 'presentation.adoc' using the reveal.js converter
+var options = { safe: 'safe', backend: 'revealjs' }
+asciidoctor.convertFile('presentation.adoc', options) // <1>
+----
+<1> Creates a file named `presentation.html` (in the directory where command is run)
+
+To execute the script, open a terminal and type:
+
+ $ node convert-slides.js
+
+You can open the `presentation.html` file in your browser and enjoy!
 
 == Syntax Examples
 
@@ -479,7 +514,7 @@ print "$0: hello world\n"
 ....
 
 [NOTE]
-Alternatively, you can use http://coderay.rubychan.de[Coderay] or http://pygments.org[Pygments] as syntax highlighters if you are using the Asciidoctor/Ruby/Bundler toolchain (not Asciidoctor.js/Javascript/NPM).
+Alternatively, you can use http://coderay.rubychan.de[Coderay] or http://pygments.org[Pygments] as syntax highlighters if you are using the Asciidoctor/Ruby/Bundler toolchain (not Asciidoctor.js/JavaScript/npm).
 Check the `examples/` directory for examples and notes about what needs to be done for them to work.
 They are considered unsupported by the asciidoctor-reveal.js project.
 
@@ -639,7 +674,7 @@ In AsciiDoc the `data-state` can be applied to a slide by adding a state attribu
 == Epic Topic
 ----
 
-That state can be queried from Javascript or used in CSS to apply further customization to your slide deck.
+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]
@@ -893,6 +928,16 @@ Defaults to *block*
 |<percentage value>
 | Factor of the display size that should remain empty around the content. Defaults to *0.1*
 
+|:revealjs_pdfseparatefragments:
+|*true*, false
+|In PDF export, put each fragment on a separate page.
+Defaults to *true*
+
+|:revealjs_pdfmaxpagesperslide:
+|<integer>
+|In PDF export, when a slide does not fit on a single page, maximum number of pages.
+Defaults to *1*
+
 |===
 
 If you want to build a custom theme or customize an existing one you should
@@ -936,9 +981,9 @@ TIP: To work properly, this plugin requires a Chrome-based browser.
 Additional reveal.js plugins can be installed and activated using AsciiDoc attributes and external javascript files.
 
 . Extract the plugin files in a directory
-. Create a Javascript file that will contain the Javascript statements to load the plugin (only one required even if you are using several plugins)
-. Add a `:revealjs_plugins:` attribute to point to that Javascript file
-. (Optional) Add a `:revealjs_plugins_configuration:` attribute to point to a Javascript file that configures the plugins you use
+. Create a JavaScript file that will contain the JavaScript statements to load the plugin (only one required even if you are using several plugins)
+. Add a `:revealjs_plugins:` attribute to point to that JavaScript file
+. (Optional) Add a `:revealjs_plugins_configuration:` attribute to point to a JavaScript file that configures the plugins you use
 
 Looking at the example provided in the repository will provide guidance: link:examples/revealjs-plugins.adoc[AsciiDoc source], link:examples/revealjs-plugins.js[Plugin Loader], link:examples/revealjs-plugins-conf.js[Plugin Configuration].
 
@@ -949,15 +994,31 @@ A {uri-revealjs-gh}/wiki/Plugins,-Tools-and-Hardware[list of existing reveal.js
 == Minimum Requirements
 
 Our requirements are expressed in our packages and by our dependencies.
-Basically, all you need is the package manager of the flavor of Asciidoctor-Reveal.js you are interested to run:
+Basically, all you need is the package manager of the flavor of Asciidoctor reveal.js you are interested to run:
 
 * With Ruby / Bundler: A https://www.ruby-lang.org/en/downloads/[recent Ruby] and https://bundler.io/[Bundler]
-* With Javascript (Node.js) / NPM: a https://nodejs.org/en/download/[recent Node.js] environment
+* With JavaScript (Node.js) / npm: a https://nodejs.org/en/download/[recent Node.js] environment
 
 If you need more details about our dependencies check out Asciidoctor dependencies:
 
-* With Ruby / Bundler: https://asciidoctor.org/#requirements[Asciidoctor] 1.5.6
-* With Javascript (Node.js) / NPM: https://github.com/asciidoctor/asciidoctor.js/blob/v1.5.6/package.json[Asciidoctor.js] 1.5.6
+* With Ruby / Bundler: https://github.com/asciidoctor/asciidoctor/tree/v2.0.10#requirements[Asciidoctor] 2.0.10
+* With JavaScript (Node.js) / NPM: https://github.com/asciidoctor/asciidoctor.js/blob/v2.0.3/packages/core/package.json[Asciidoctor.js] 2.0.3
+
+
+== Showcase Presentations
+
+=== Power Catchup -- Everything Practical and Important in Java 9 to 13
+
+A smooth presentation, featuring video backgrounds, slide transitions, code and callout examples and the use of notes.
+
+https://bentolor.github.io/java9to13/[Presentation] and https://github.com/bentolor/java9to13[source]
+
+==== Screenshots
+
+image:{showcasedir}/java9to13_4.png[width=200,link=./{showcasedir}/java9to13_4.png] image:{showcasedir}/java9to13_1.jpg[width=200,link={showcasedir}/java9to13_1.jpg]
+
+image:{showcasedir}/java9to13_2.jpg[width=200,link={showcasedir}/java9to13_2.jpg]
+image:{showcasedir}/java9to13_3.png[width=200,link={showcasedir}/java9to13_3.png]
 
 
 == Contributing

data/Rakefile

@@ -71,7 +71,7 @@ def build_converter(mode = :pretty)
     Asciidoctor::TemplatesCompiler::RevealjsSlim.compile_converter(
       templates_dir: TEMPLATES_DIR,
       class_name: 'Asciidoctor::Revealjs::Converter',
-      register_for: ['revealjs'],
+      register_for: ['revealjs', 'reveal.js'],
       backend_info: {
         basebackend: 'html',
         outfilesuffix: '.html',
@@ -107,6 +107,7 @@ namespace :examples do
   # converted slides will be put in examples/ directory
   task :convert do
     require 'slim-htag'
+    require_relative 'lib/asciidoctor-revealjs'
     Dir.glob('examples/*.adoc') do |_file|
       print "Converting file #{_file}... "
       out = Asciidoctor.convert_file _file,

data/asciidoctor-revealjs.gemspec

@@ -8,10 +8,11 @@ Gem::Specification.new do |s|
   s.authors = ['Olivier Bilodeau']
   s.email = ['olivier@bottomlesspit.org']
   s.homepage = 'https://github.com/asciidoctor/asciidoctor-reveal.js'
-  s.summary = 'Converts AsciiDoc to HTML for a Reveal.js presentation'
-  s.description = 'Reveal.JS back-end for Asciidoctor and Asciidoctor.js. Write slides in AsciiDoc!'
+  s.summary = 'A reveal.js converter for Asciidoctor. Write your slides in AsciiDoc!'
+  s.description = 'Converts AsciiDoc documents into HTML5 presentations designed to be executed by the reveal.js presentation framework.'
   s.license = 'MIT'
 
+
   files = begin
     if (result = Open3.popen3('git ls-files -z') {|_, out| out.read }.split %(\0)).empty?
       Dir['**/*']
@@ -29,7 +30,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = Dir['README.adoc', 'LICENSE.adoc', 'HACKING.adoc']
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'asciidoctor', ['>= 1.5.6', '< 3.0.0']
+  s.add_runtime_dependency 'asciidoctor', ['>= 2.0.0', '< 3.0.0']
   s.add_runtime_dependency 'thread_safe', '~> 0.3.5'
   s.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
 
@@ -38,11 +39,13 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry', '~> 0.10.4'
   if RUBY_ENGINE != 'jruby'
     s.add_development_dependency 'pry-byebug'
+    s.add_development_dependency 'pygments.rb'
   end
   s.add_development_dependency 'colorize'
   s.add_development_dependency 'asciidoctor-templates-compiler', '~> 0.4.2'
   s.add_development_dependency 'slim', '~> 3.0.6'
   s.add_development_dependency 'slim-htag', '~> 0.1.0'
+  s.add_development_dependency 'rouge'
   # Overriden in Gemfile and Gemfile.upstream for now
   #s.add_development_dependency 'opal', '~> 0.11.1'
 end

data/examples/font-awesome.adoc

@@ -0,0 +1,24 @@
+// .font-awesome
+// Testing font-awesome icons
+// :include: //body/script | //div[@class="slides"]
+// :header_footer:
+= Font Awesome Tests
+:icons: font
+
+== !
+
+icon:heart[2x]
+
+== !
+
+icon:heart[size=5x]
+
+== !
+
+// TODO
+[red]
+icon:heart[size=5x]
+
+== !
+
+icon:stackpath[size=5x]

data/examples/multi-destination-content.adoc

@@ -50,6 +50,8 @@ Some overview
 ----
 
 ifdef::backend-revealjs[=== !]
+// TODO one day would be nice to allow
+//ifdef::backend-reveal.js[=== !]
 
 Detailed view
 

data/examples/source-rouge.adoc

@@ -0,0 +1,41 @@
+// .source-rouge
+// Demonstration of source highlighting with Rouge
+// :include: //div[@class="slides"]
+// :header_footer:
+= Source Code with Rouge
+:icons: font
+:source-highlighter: rouge
+:rouge-style: monokai
+
+== Requirements
+
+WARNING: This will not work from Asciidoctor.js
+
+[NOTE]
+====
+For this to work. You need to add:
+
+    gem 'rouge'
+
+to your `Gemfile` and re-run:
+
+    bundle install
+====
+
+== Use the Source
+
+[source, rust]
+----
+fn main() {
+    println!("Hello World!");
+}
+----
+
+== Stretch the Source
+
+[source, rust, role="stretch"]
+----
+fn main() {
+    println!("Hello stretched World!");
+}
+----

data/examples/tables-styles.adoc

@@ -0,0 +1,141 @@
+= Table styles
+
+== Default table with header
+
+[cols=2*,options=header]
+|===
+| Header 1
+| Header 2
+
+| Row 1, Col1
+| Row 1, Col2
+
+| Row 2, Col1
+| Row 2, Col2
+
+|===
+
+== Frames
+
+=== Frame none
+
+[cols=2*,frame=none,options=header]
+|===
+| Header 1
+| Header 2
+
+| Row 1, Col1
+| Row 1, Col2
+
+| Row 2, Col1
+| Row 2, Col2
+
+|===
+
+=== Frame sides
+
+[cols=2*,frame=sides,options=header]
+|===
+| Header 1
+| Header 2
+
+| Row 1, Col1
+| Row 1, Col2
+
+| Row 2, Col1
+| Row 2, Col2
+
+|===
+
+=== Frame topbot
+
+[cols=2*,frame=topbot,options=header]
+|===
+| Header 1
+| Header 2
+
+| Row 1, Col1
+| Row 1, Col2
+
+| Row 2, Col1
+| Row 2, Col2
+
+|===
+
+== Grid
+
+=== Grid none
+
+[cols=2*,grid=none,options=header]
+|===
+| Header 1
+| Header 2
+
+| Row 1, Col1
+| Row 1, Col2
+
+| Row 2, Col1
+| Row 2, Col2
+
+|===
+
+=== Grid cols
+
+[cols=2*,grid=cols,options=header]
+|===
+| Header 1
+| Header 2
+
+| Row 1, Col1
+| Row 1, Col2
+
+| Row 2, Col1
+| Row 2, Col2
+
+|===
+
+=== Grid rows
+
+[cols=2*,grid=rows,options=header]
+|===
+| Header 1
+| Header 2
+
+| Row 1, Col1
+| Row 1, Col2
+
+| Row 2, Col1
+| Row 2, Col2
+
+|===
+
+== Combo
+
+=== Grid none, frame none
+
+[cols=2*,grid=none,frame=none,options=header]
+|===
+| Header 1
+| Header 2
+
+| Row 1, Col1
+| Row 1, Col2
+
+| Row 2, Col1
+| Row 2, Col2
+
+|===
+
+== Alignments
+
+[cols="^,<,>", options="header"]
+|===
+
+| Name
+| Description
+| Version
+
+| Asciidoctor
+| Awesome way to write documentation
+| 2.0.4
+|===