Skip to content

v3.0.0
Compare
Choose a tag to compare
@obilodeau obilodeau released this 07 Jan 06:42
· 362 commits to master since this release
v3.0.0
7a0152f

An API breaking release for Asciidoctor.js users that brings a bright future of long term stability. New Reveal.js features supported: background opacity, background positions, and PDF export. AsciiDoc table options now supported. A big FontAwesome update. Many other little improvements and polish.

Special heads-up: we are already planning for another major release since Reveal.js 3.8 support will be considered a breaking change. They changed how it is loaded and requires a template change incompatible with Reveal.js 3.1-3.7.

Distribution

Changelog

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()

More breaking changes!

  • Node.js package name changed from asciidoctor-reveal.js to @asciidoctor/reveal.js (#252, #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 #287.
  • Upgraded to Font-Awesome 5.8.2 from 4.3.0 which contains some backward incompatible changes (#268)
  • asciidoctor-reveal.js now requires Asciidoctor 2.0.0+ or Asciidoctor.js 2.0.0+ (#290)
  • Dropped support for end-of-life Ruby version 2.1 and 2.2 (#247)

Compliance

  • Added support for table frame, grid, header and alignment options (#29, #42, #56, #288)
  • Source code callout style aligned with Asciidoctor's (#293, #300)
  • Added support for Reveal.js data-background-opacity (#269)
  • Added support for Reveal.js data-background-position (#273, #274)
  • Updated the process to include the generated converter in releases (#265, #302)

Enhancements

  • Support for Asciidoctor.js 2.0.0+ which brings a command line interface (#254)
  • Process updates, narrower install version range and compatibility matrix regarding Asciidoctor.js (#187, #303)
  • Migrated to Asciidoctor 2.0.0 new Syntax Highlighter API (#261, #287)
  • Added support for Reveal.js PDF export options (#277)
  • Upgraded to Font-Awesome 5.8.2 (#268)
  • We now accept reveal.js as converter/backend name in addition to revealjs (#253, #297)
  • Babel integration example API updated to use asciidoctor-reveal.js current API (#285, #298)
  • Node.js package clean-ups (#279, #281, #282)
  • Upgrade Opal to use a compatible version with Asciidoctor.js 2.0.3 (#289)
  • Documentation improvements (#292, #302)
  • Improvements to tests (#294)

Bug Fixes

  • Babel integration example updated for security (#285)

Infrastructure

  • Updated Travis' JRuby to fix issues with bundler (#295)

Release meta

  • Released on: 2020-01-07
  • Released by: Olivier Bilodeau
  • Release beer: Porter Baltique Édition Spéciale 2019, Les Trois Mousquetaires

git tag | full diff | milestone

Credits

Thanks to the following people who contributed to this release:

@bentolor, @cgxeiji, @gquintana, @Mogztter, @obilodeau and Daniel Mulholland

Assets 2