asciidoctor-revealjs 4.0.1 → 4.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c663654cbc023ea219477c04797c5e035037749d2410e37245971c97c1cce3c
-  data.tar.gz: 4bfd5e51e1e796d41a33475bcb440a67ec77e29d6f36729a4453195f923faf72
+  metadata.gz: 6b2343b79440b211359d9b5a8cf73fa259d0c46936b37c1d732da9f5610187f0
+  data.tar.gz: 8261031cd8f7a5528a8a4bfc5cd23cecf613f0f66dd6aca1c225de2a9080b4c0
 SHA512:
-  metadata.gz: 6734ffe16c6f11c50c903826f8bbeef70b7a859818798fd4a9f4889af11b5b44625d789dccf2d9a11fed8e3c1ad8ae5c7b7447ba11f5fd75bd90499aa85e0c34
-  data.tar.gz: 27d91a397a3915b0520105854c86b91ec4d7852192b39da7a6d86d271be0b2a2990a8cf06988d8aaf3c1e572d0be3b2cf90653f1ea40f24ba77ea0ceebdeefce
+  metadata.gz: 8e823350491fb2ac4ccde6e606a1e5fdceaffb6a7c4bc30bf21c2c8b6d2132052fc0ea17cd2507584dcccb33d48e842b51514c9d433b9afa24bd259649c5bd7f
+  data.tar.gz: 9fcfd3e2f9703d1032207127b31e836ffa14a83b56414e646cecf183ef15389ca6fe6d6ebf759254c351aa98535a1db06513f80f5f256f76c421d0b036cbbda6

data/README.adoc

@@ -18,8 +18,9 @@ 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-revealjs-home: https://revealjs.com
+:uri-revealjs-gh: https://github.com/hakimel/reveal.js/blob/v3.9
+:uri-revealjs-doc: {uri-revealjs-gh}/README.md
 :uri-nodejs-download: https://nodejs.org/en/download/
 :showcasedir: showcase
 
@@ -44,27 +45,17 @@ There are four main technology stacks that can convert AsciiDoc into HTML5 / rev
 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/v3.1.0#readme[3.1.0] (latest release)
+{uri-project-repo}/tree/v4.0.0#readme[4.0.1] (latest from 4.x series)
 ⁃
-{uri-project-repo}/tree/v2.0.1#readme[2.0.1] (latest from 2.x series)
+{uri-project-repo}/tree/v3.1.0#readme[3.1.0] (latest from 3.x series)
 ⁃
-{uri-project-repo}/tree/v1.1.3#readme[1.1.3] (latest from 1.1 series)
-⁃
-{uri-project-repo}/tree/maint-1.0.x#readme[1.0.x]
-⁃
-{uri-project-repo}/tree/reveal.js-2.x#readme[Unversioned pre-release] (compatible with RevealJS 2.x)
+{uri-project-repo}/tree/reveal.js-2.x#readme[Unversioned pre-release] (compatible with reveal.js 2.x)
 endif::[]
 
 
 == Ruby Setup
 
-NOTE: asciidoctor-reveal.js is now a Ruby Gem.
-To ensure repeatability, we recommend that you manage your presentation projects using bundler.
-
-For a quick start clone our https://github.com/obilodeau/presentation-revealjs-starter[starter repository] and follow instructions there.
-
-For more complete instructions, read on.
-
+NOTE: To ensure repeatability, we recommend that you manage your presentation projects using http://bundler.io/[bundler].
 
 === Prerequisites
 
@@ -129,6 +120,29 @@ 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.
 
+=== Features Unique to the Ruby CLI
+
+Starting with 4.0.0 you can specify a set of custom templates to use instead of the ones provided by this project.
+This can help you achieve even more concise AsciiDoc syntax and integration with reveal.js at the cost of more maintenance.
+
+To use it, add the following dependencies to your `Gemfile`:
+
+  gem 'tilt', '~>2.0'
+  gem 'slim', '~>4.0'
+
+Then install the dependencies with:
+
+  $ bundle install
+
+The feature is activated with the `--template-dir` or `-T` option:
+
+  $ bundle exec asciidoctor-revealjs -T templates/ CONTENT_FILE.adoc
+
+Any individual template file not provided in the directory specified on the command-line will fall back to the template provided by your version of Asciidoctor reveal.js.
+Refer to our https://github.com/asciidoctor/asciidoctor-reveal.js/tree/master/templates[templates] for inspiration.
+
+This feature hasn't been ported to the JavaScript CLI (and API) or the standalone executables.
+
 
 == Node / JavaScript Setup
 
@@ -301,7 +315,7 @@ A Great Story
 --
 ----
 
-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-doc}#speaker-notes[speaker notes].
 Other syntax exists to create speaker notes, see `examples/speaker-notes.adoc`.
 
 Starting with Reveal.js 3.5 speaker notes supports configurable layouts:
@@ -388,7 +402,7 @@ NOTE: The `canvas` keyword can be used instead of `background` for the same effe
 Is very yellow
 ----
 
-Slide Three applies the attribute {uri-revealjs-gh}#slide-backgrounds[data-background-color] to the `reveal.js` <section> tag.
+Slide Three applies the attribute {uri-revealjs-doc}#slide-backgrounds[data-background-color] to the `reveal.js` <section> tag.
 Anything accepted by CSS color formats works.
 
 
@@ -405,7 +419,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.
 The `size` attribute is also supported.
-See the {uri-revealjs-gh}#image-backgrounds[relevant reveal.js documentation] for details.
+See the {uri-revealjs-doc}#image-backgrounds[relevant reveal.js documentation] for details.
 
 NOTE: Background images file names are now relative to the `:imagesdir:` attribute if set.
 
@@ -443,7 +457,7 @@ For example:
 == Nice background!
 ----
 
-See {uri-revealjs-gh}#video-backgrounds[the relevant reveal.js documentation] for details.
+See {uri-revealjs-doc}#video-backgrounds[the relevant reveal.js documentation] for details.
 Note that the `data-` prefix is not required in asciidoc files.
 
 
@@ -457,7 +471,7 @@ The background can be replaced with anything a browser can render in an iframe u
 == a youtube video
 ----
 
-See {uri-revealjs-gh}#iframe-backgrounds[the relevant reveal.js documentation] for details.
+See {uri-revealjs-doc}#iframe-backgrounds[the relevant reveal.js documentation] for details.
 
 
 === Slide Transitions
@@ -475,7 +489,7 @@ This slide will override the presentation transition and zoom!
 Choose from three transition speeds: default, fast or slow!
 ----
 
-See {uri-revealjs-gh}#slide-transitions[the relevant reveal.js documentation] for details.
+See {uri-revealjs-doc}#slide-transitions[the relevant reveal.js documentation] for details.
 
 
 === Fragments
@@ -492,9 +506,9 @@ See {uri-revealjs-gh}#slide-transitions[the relevant reveal.js documentation] fo
 ----
 
 Slide Four has bullets that are revealed one after the other.
-This is what `reveal.js` calls http://lab.hakim.se/reveal-js/#/fragments[fragments].
+This is what `reveal.js` calls {uri-revealjs-home}/fragments[fragments].
 Applying the step option or role on a list (`[%step]` or `[.step]`) will do the trick.
-Here is {uri-revealjs-gh}#fragments[the relevant reveal.js
+Here is {uri-revealjs-doc}#fragments[the relevant reveal.js
 documentation] on the topic.
 Note that only `fade-in` is supported for lists at the moment.
 
@@ -510,7 +524,7 @@ To apply that class to block simply use asciidoctor's class assignment:
 
     [.stretch]
 
-See {uri-revealjs-gh}#stretching-elements[reveal.js documentation on stretching elements].
+See {uri-revealjs-doc}#stretching-elements[reveal.js documentation on stretching elements].
 
 
 === Videos
@@ -543,7 +557,7 @@ You can activate Highlight.js syntax highlighting (disabled by default) by setti
 ----
 
 [NOTE]
-----
+====
 By default, we are using a prebuilt version of Highlight.js with 34 commonly used languages hosted on https://cdnjs.com/[cdnjs].
 You can load additionnal languages using the `:highlightjs-languages:` attribute:
 
@@ -559,7 +573,7 @@ You can also load Highlight.js from a custom base directory (or remote URL) usin
 :highlightjsdir: highlight
 // load from jsdelivr CDN
 //:highlightjsdir: https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build
-----
+====
 
 Once enabled, you can write code blocks as usual:
 
@@ -612,7 +626,7 @@ This is a vertical subslide
 
 Slide Six uses the vertical slide feature of `reveal.js`.
 Slide Six.One will be rendered vertically below Slide Six.
-Here is {uri-revealjs-gh}#markup[the relevant reveal.js
+Here is {uri-revealjs-doc}#markup[the relevant reveal.js
 documentation] on that topic.
 
 === Columns layout
@@ -713,6 +727,32 @@ Content can be centered by adding the `is-vcentered` class to the slide.
 image::large-image.png[]
 ....
 
+Text alignment of columns is also supported.
+Text content on individual columns can be aligned with `has-text-left`, `has-text-right` and `has-text-justified` CSS classes.
+
+[source, asciidoc]
+....
+[.columns]
+== Column Text Alignment
+
+[.column.has-text-left]
+--
+Something Short
+
+Something So Long That We Need It Aligned
+--
+
+[.column.has-text-justified]
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+
+[.column.has-text-right]
+--
+Something Short
+
+Something So Long That We Need It Aligned
+--
+....
+
 
 === Asciidoctor reveal.js specific roles
 
@@ -769,7 +809,7 @@ title that look like this: `:name: value`.
 This converter supports changing the color, image, video, iframe and
 transitions of the title slide.
 
-Read {uri-revealjs-gh}#slide-backgrounds[the relevant reveal.js documentation] to understand what attributes need to be set.
+Read {uri-revealjs-doc}#slide-backgrounds[the relevant reveal.js documentation] to understand what attributes need to be set.
 Keep in mind that for title slides you must replace `data-` with `title-slide-`.
 
 ifeval::[{safe-mode-level} >= 20]
@@ -852,7 +892,7 @@ If the `:customcss:` attribute value is empty then `asciidoctor-revealjs.css` is
 
 === Slide state
 
-Reveal.js supports a {uri-revealjs-gh}#slide-states[data-state] tag that can be added on slides which gets rendered into `<section>` tags.
+Reveal.js supports a {uri-revealjs-doc}#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]
@@ -945,7 +985,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-doc}#theming[built-in themes].
 
 |:revealjs_customtheme:
 |<file\|URL>
@@ -1037,7 +1077,7 @@ print:: only show slide numbers when printing to PDF
 
 |:revealjs_navigationMode:
 |*default*, linear, grid
-|See https://github.com/hakimel/reveal.js/#navigation-mode for details
+|See {uri-revealjs-doc}#navigation-mode for details
 
 |:revealjs_shuffle:
 |true, *false*
@@ -1212,14 +1252,14 @@ Defaults to *1*
 
 If you want to build a custom theme or customize an existing one you should
 look at the
-{uri-revealjs-gh}/blob/master/css/theme/README.md[reveal.js
+{uri-revealjs-gh}/css/theme/README.md[reveal.js
 theme documentation] and use the `revealjs_customtheme` AsciiDoc attribute to
 activate it.
 
 
 === PDF Export
 
-Follow https://github.com/hakimel/reveal.js#pdf-export[reveal.js' documentation] for PDF export.
+Follow {uri-revealjs-doc}#pdf-export[reveal.js' documentation] for PDF export.
 We would add that we have successfully used PDF export without the requirement of a Web server.
 
 
@@ -1253,7 +1293,7 @@ Additional reveal.js plugins can be installed and activated using AsciiDoc attri
 
 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].
 
-Read {uri-revealjs-gh}#dependencies[the relevant reveal.js documentation] to understand more about reveal.js plugins.
+Read {uri-revealjs-doc}#dependencies[the relevant reveal.js documentation] to understand more about reveal.js plugins.
 A {uri-revealjs-gh}/wiki/Plugins,-Tools-and-Hardware[list of existing reveal.js plugins] is also maintained upstream.
 
 

data/Rakefile

@@ -10,6 +10,7 @@ CONVERTER_FILE = 'lib/asciidoctor-revealjs/converter.rb'
 JS_FILE = 'build/asciidoctor-reveal.js'
 DIST_FILE = 'dist/main.js'
 TEMPLATES_DIR = 'templates'
+PUBLIC_DIR = 'public'
 
 file CONVERTER_FILE => FileList["#{TEMPLATES_DIR}/*"] do
   build_converter :fast
@@ -53,6 +54,7 @@ task :build => 'build:converter'
 
 task :clean do
   rm_rf CONVERTER_FILE
+  rm_rf PUBLIC_DIR
 end
 
 def build_converter(mode = :pretty)
@@ -112,7 +114,7 @@ end
 namespace :examples do
   desc 'Converts all the test slides into fully working examples that you can look in a browser'
   # converted slides will be put in examples/ directory
-  task :convert do
+  task :convert => 'build:converter' do
     require 'slim-htag'
     require_relative 'lib/asciidoctor-revealjs'
     Dir.glob('examples/*.adoc') do |_file|
@@ -120,8 +122,7 @@ namespace :examples do
       out = Asciidoctor.convert_file _file,
         :safe => 'safe',
         :backend => 'revealjs',
-        :base_dir => 'examples',
-        :template_dir => 'templates'
+        :base_dir => 'examples'
       if out.instance_of? Asciidoctor::Document
         puts "✔️".green
       else
@@ -137,6 +138,20 @@ namespace :examples do
       `ruby -run -e httpd . -p 5000 -b 127.0.0.1`
     end
   end
+
+  task :publish do
+    FileUtils.rm_rf PUBLIC_DIR
+    Dir.mkdir PUBLIC_DIR
+    Dir.mkdir "#{PUBLIC_DIR}/reveal.js"
+    FileUtils.cp 'src/index.html', "#{PUBLIC_DIR}/index.html"
+    FileUtils.cp_r 'node_modules/reveal.js/', "#{PUBLIC_DIR}"
+    FileUtils.cp_r 'examples/images/', "#{PUBLIC_DIR}"
+    FileUtils.cp 'examples/release-4.0.html', "#{PUBLIC_DIR}/release-4.0.html"
+    FileUtils.cp 'examples/release-4.0.css', "#{PUBLIC_DIR}/release-4.0.css"
+    FileUtils.cp 'examples/release-4.1.html', "#{PUBLIC_DIR}/release-4.1.html"
+    FileUtils.cp 'examples/release-4.1.css', "#{PUBLIC_DIR}/release-4.1.css"
+    FileUtils.cp 'examples/a11y-dark.css', "#{PUBLIC_DIR}/a11y-dark.css"
+  end
 end
 
 task 'test' => 'doctest'

data/asciidoctor-revealjs.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
 
   s.add_development_dependency 'rake', '~> 13.0.0'
-  s.add_development_dependency 'asciidoctor-doctest', '= 2.0.0.beta.5'
+  s.add_development_dependency 'asciidoctor-doctest', '= 2.0.0.beta.7'
   s.add_development_dependency 'minitest', '~> 5.14'
   if RUBY_ENGINE != 'jruby'
     s.add_development_dependency 'pry', '~> 0.12.0'

data/examples/a11y-dark.css

@@ -0,0 +1,99 @@
+/* a11y-dark theme */
+/* Based on the Tomorrow Night Eighties theme: https://github.com/isagalaev/highlight.js/blob/master/src/styles/tomorrow-night-eighties.css */
+/* @author: ericwbailey */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+  color: #d4d0ab;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-tag,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class,
+.hljs-regexp,
+.hljs-deletion {
+  color: #ffa07a;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params,
+.hljs-meta,
+.hljs-link {
+  color: #f5ab35;
+}
+
+/* Yellow */
+.hljs-attribute {
+  color: #ffd700;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet,
+.hljs-addition {
+  color: #abe338;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+  color: #32aaee;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+  color: #dcc6e0;
+}
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  background: #2b2b2b;
+  color: #f8f8f2;
+  padding: 0.5em;
+}
+
+.hljs-emphasis {
+  font-style: italic;
+}
+
+.hljs-strong {
+  font-weight: bold;
+}
+
+@media screen and (-ms-high-contrast: active) {
+  .hljs-addition,
+  .hljs-attribute,
+  .hljs-built_in,
+  .hljs-builtin-name,
+  .hljs-bullet,
+  .hljs-comment,
+  .hljs-link,
+  .hljs-literal,
+  .hljs-meta,
+  .hljs-number,
+  .hljs-params,
+  .hljs-string,
+  .hljs-symbol,
+  .hljs-type,
+  .hljs-quote {
+    color: highlight;
+  }
+
+  .hljs-keyword,
+  .hljs-selector-tag {
+    font-weight: bold;
+  }
+}

data/examples/autoslide.adoc

@@ -0,0 +1,22 @@
+= Autoslide!
+// automatically proceed to the next slide after 5 seconds
+:revealjs_autoSlide: 5000
+
+== Slide 0
+
+I can do it in 5 seconds!
+
+// on this slide we need 10 seconds
+[autoslide=10000]
+== Slide 1
+
+All things considered, let's try again in 10 seconds.
+
+[autoslide=1000]
+== Slide 2
+
+Don't blink or you'll miss me :)
+
+== Slide 3
+
+(: