Skip to content

v2.0.0
Compare
Choose a tag to compare
@obilodeau obilodeau released this 01 Mar 06:05
· 489 commits to master since this release
v2.0.0
edf3a73

Easier speaker notes and background colors with CSS, configurable reveal.js plugins, new floating roles and support for reveal.js 3.6 and 3.7 new options. This is a major release due to a breaking Node.js API change.

Distribution

Changelog

Upgrade considerations

  • Node.js API change!

If you generate your reveal.js presentations using the node/javascript toolchain, you need to change how the Asciidoctor-reveal.js back-end is registered to Asciidoctor.js. Instead of require('asciidoctor-reveal.js') you need to do:

    var asciidoctorRevealjs = require('asciidoctor-reveal.js');
    asciidoctorRevealjs.register()

This change enables new use cases like embedding a presentation in a React web app.

  • Anchor links generated by Asciidoctor-reveal.js will change from now on when revealjs_history is set to true (default is false). This is the consequence of upstream fixing a long-standing issue (see #1230 and #2037 and us removing a workaround (see #232). Explicit anchors are not affected.
  • Custom CSS might require adjustments. Source and listing block are less deeply nested into div blocks now. See #195 and #223.
  • The reveal.js marked and markdown plugins are disabled by default now. It is unlikely that they could have been used anyway. See #204.
  • Dropped the ability to override the Reveal.JS theme and transitions dynamically with the URL query. Was not compatible with Reveal.JS 3.x series released 4 years ago.

Enhancements

  • Easier speaker notes: a .notes role that apply to many AsciiDoc blocks (open, sidebar and admonition) (#202)
  • Added a role right that would apply a float: right to any block where it would be assigned (#197, #213, #215)
  • Allow the background color of slides to be set using CSS (#16, #220, #226, #229)
  • Reveal.js's fragmentInURL option now supported (#206, #214)
  • Documentation improvements (#141, #182, #190, #203, #215, #216, #222)
  • Support for Asciidoctor.js 1.5.6 and build simplification (#189, #217)
  • Support to specify and use reveal.js plugins without modifying Asciidoctor-reveal.js's source code (#196, #118, #201, #204)
  • Node / Javascript back-end is now loaded on-demand with the register() method.
    This allows embedding Asciidoctor-reveal.js into React or any other modern Javascript environment.
    (#205, #218, #219)
  • revealjsdir attribute is set to a more sensible default when running under Node.js (#191, #228)
  • Node / Javascript back-end updated to use Asciidoctor.js 1.5.9. This extension is built with Opal 0.11.99.dev (6703d8d) in order to be compatible. (#227, #240)

Compliance

  • AsciiDoc source callout icons now work (#54, #168, #224)
  • New reveal.js 3.7.0 features supported: controlsTutorial, controlsLayout, controlsBackArrows, new slideNumber formats, showSlideNumber, autoSlideMethod, parallaxBackgroundHorizontal, parallaxBackgroundVertical and display configuration parameters are now supported (#212, #239, #208, #242
  • Asciidoctor 2.0 ready (#245)

Bug Fixes

  • Reveal.js' stretch class now works with listing blocks (#195, #223)
  • Auto-generated slide IDs with unallowed characters (for revealjs history) now work properly. Upstream reveal.js fixed a bug in 3.7.0 (#2037) and we removed our broken workaround. (#192, #232)

Infrastructure::

  • Travis testing prepared for upcoming Asciidoctor 2.0 (#216)
  • Travis testing for Ruby 2.6 (#243)

Release meta

  • Released on: 2019-02-28
  • Released by: @obilodeau
  • Release beer: President's Choice Blonde Brew De-alcoholized Beer (Sober February Successfully Completed!)

git tag | full diff | milestone

Credits

Thanks to the following people who contributed to this release:

@a4z, @mojavelinux, @Mogztter, @jirutka, @obilodeau, @stevewillson, @vivien

Assets 2