Skip to content

Latest commit

 

History

History
782 lines (541 loc) · 42.5 KB

CHANGELOG.md

File metadata and controls

782 lines (541 loc) · 42.5 KB
Raw

Changelog

This document provides a high-level view of the changes introduced in Asciidoctor reveal.js by release. For a detailed view of what has changed, refer to the commit history on GitHub.

master (unreleased)

5.1.0 (2023-12-12)

Enhancements

  • Upgrade to reveal.js 4.5.0

Bug Fixes

  • Fix a compatibility issue between Opal and Asciidoctor.js 3.x by upgrading Opal to 1.7.3
  • Fix a compatibility issue with asciidoctor-chart by upgrading asciidoctor-templates-compiler to 0.7.0

5.0.1 (2023-06-24)

Upgrade considerations

  • Plugin marked has been removed in reveal.js 4.0.0 and plugin markdown has been disabled. As a result, the revealjs_plugin_markdown and revealjs_plugin_marked attributes have no effect anymore.
  • revealjs_plugins and revealjs_plugins_configuration are replaced by Docinfo files.

Before

presentation.adoc

= Third-party Plugins
:revealjs_plugins: examples/revealjs-plugins.js
:revealjs_plugins_configuration: examples/revealjs-plugins-conf.js

// ...

revealjs-plugin.js

{ src: 'revealjs-plugins/reveal.js-menu/menu.js' },
{ src: 'revealjs-plugins/chalkboard/chalkboard.js' }

revealjs-plugin-conf.js

menu: {
  side: 'right',
  openButton: false
},
keyboard: {
  67: function() { RevealChalkboard.toggleNotesCanvas() },
  66: function() { RevealChalkboard.toggleChalkboard() }
},

After

presentation.adoc

= Third-party Plugins
:docinfo: private

// ...

presentation-docinfo-footer.html

<script src="revealjs-plugins/menu/menu.js"></script>
<link rel="stylesheet" href="revealjs-plugins/chalkboard/style.css">
<script src="revealjs-plugins/chalkboard/plugin.js"></script>
<script>
  Reveal.configure({
    menu: {
      side: 'right',
      openButton: false
    },
    keyboard: {
      67: function() { RevealChalkboard.toggleNotesCanvas() },
      66: function() { RevealChalkboard.toggleChalkboard() }
    }
  })
  Reveal.registerPlugin(RevealMenu)
  Reveal.registerPlugin(RevealChalkboard)
</script>
  • If you are using third party plugins (such as chalkboard), please upgrade to the latest version.

Bug Fixes

  • Include Rouge stylesheet when `:source-highlighter: rouge is present and when there's a least one source block.
  • Fix quotation marks and apostrophes
  • Fix subscripts erroneously mapped to superscripts

Enhancements

  • Upgrade to reveal.js 4.1.2 (#370)
  • Add support for the Auto-Animate feature (#439)
  • Add support for the built-in search plugin (#441)
    • You can enable this plugin using :revealjs_plugin_search: enabled.
  • Upgrade MathJax to version 3.2.0
  • Display all the authors (inclusing their email addresses)
  • Upgrade development dependencies
    • Bump path-parse from 1.0.6 to 1.0.7 in /test/js-babel
    • Bump path-parse from 1.0.6 to 1.0.7
    • Bump glob-parent from 5.1.0 to 5.1.2
    • Bump lodash from 4.17.19 to 4.17.21 in /test/js-babel
    • Bump y18n from 4.0.0 to 4.0.1
  • Drop thread_safe and concurrent-ruby dependencies
  • Add favicon to HTML if its attribute is present in AsciiDoc

Documentation

4.1.0 (2020-12-19)

Upgrade considerations

  • When a background-video attribute points to a file, that file is now looked up relative to the imagesdir document attribute. This new behavior aligns with what images and video macros already did. Existing slide decks using both imagesdir and background-video will need to move some files around. See #356 for details.

Enhancements

  • Introduced a step attribute to control the display order of elements
  • %step option can now be used on most blocks
  • Added revealjs_disablelayout attribute to disable layout (#381)
  • Added support for Font Awesome icon sets using the set. For instance: icon:font-awesome-flag[set=fab] (#393)
  • Upgraded Font Awesome to 5.15.1
  • Introduced an attribute to configure Font Awesome version font-awesome-version (#392)
  • Added support for data attributes using AsciiDoc attributes prefixed by data- (#241)
  • Added text alignment options to our columns layout feature: has-text-left, has-text-right and has-text-justified. See #354 for details.
  • Added a mathjaxdir attribute to control where MathJax is loaded from (#350)
  • MathJax updated to version 2.7.6 ( #355, #361)
  • Added new examples: MathJax, MathJax-CDN ( #350, #359)
  • Documentation improvements ( #349, #351, #371, #374)

Compliance

  • Added support for footnotes (#30)
  • Added support for built-in text alignments: text-left, text-right, text-center and text-justify (#380)
  • autoslide attribute is now supported at the slide level ( #367, #368)
  • Implemented the muted option for the video macro for YouTube and Vimeo (#358)
  • background-video paths are now resolved using media_uri (#356)

Bug Fixes

  • Fixed a padding issue in columns layout (#372)
  • autoplay option fixed for YouTube and Vimeo videos (#357)
  • Removed image resizing behavior when columns are wrapped in columns layout feature ( #353, #360)

Infrastructure

  • Migrated CI jobs to GitHub Actions
  • Added Windows in CI build
  • Upgraded asciidoctor-doctest to v2.0.0.beta.7
  • Documentation migrated to Antora
  • Added an integration with Netlify to host specific slide deck examples ( #336, #346)

Release meta

git tag | full diff | milestone

Credits

Thanks to the following people who contributed to this release:

Adrian Kosmaczewski, Dan Allen, Guillaume Grossetie, Olivier Bilodeau and Romain Quinio.

4.0.1 (2020-02-18)

Repackage for NPM.

4.0.0 (2020-02-18)

A major release with a ton of improvements! All of reveal.js 3.8.0-3.9.2 new features are supported. Added a new set of column layout options for quick slides design. Highlight.js support improved. Easier templates customizations. New Java / JVM toolchain via AsciidoctorJ-reveal.js. Support was added for Asciidoctor docinfo and sectnums attributes, kbd macro and callout styles were fixed.

See the upgrade considerations section for the list of potentially breaking changes.

Upgrade considerations

  • Due to an upstream change in reveal.js 3.8.0, this back-end no longer supports earlier reveal.js versions. We added a compatibility matrix with reveal.js at the end of the README. See #301 for details.
  • Using the attribute background-opacity to alter the opacity of the title slide no longer works. When the opacity feature was introduced we forgot to align with the other title slide attributes. The feature was introduced in 3.0.0 and the bug stayed in 3.1.0. Starting with 4.0.0 use title-slide-background-opacity instead. See issue #323 for details.
  • The new Columns layout feature required a new <div> that wraps all slide content (everything except the slide title). This might impact custom CSS with strict child relationships. See issue #326 and PR #332 for details.
  • We bundle Highlight.js instead of relying on reveal.js. We reduced the core set of supported languages and added the highlightjs-languages attribute to add specific languages on demand. Depending on what type of code you were highlighting, you might need to add your language using that attribute. See #320 for details.
  • Our support of AsciiDoc docinfo attribute changed. We were previously injecting docinfo-header.html somewhere in the HTML <head>. Now, docinfo-revealjs.html goes last into the HTML <head>, docinfo-header-revealjs.html goes right before the first slide <section> and docinfo-footer-revealjs.html goes right after the last slide <section>. The new documentation is available here and the related tickets are #198 and #324.
  • Default highlight.js theme is monokai. This follows a reveal.js change.

Enhancements

Compliance

  • New reveal.js 3.8.0 and 3.9.0 features supported (#301) ** Line numbers on source code blocks using Asciidoctor's linenums attribute ** Specific lines and step-by-step code highlights using Asciidoctor's highlight attribute ** reveal.js data-preview on links and images with link can be activated by using the preview and link_preview Asciidoctor attributes respectively ** New configuration options: hash, navigationMode, shuffle, preloadIframes, totalTime, minimumTimePerSlide, hideInactiveCursor, hideCursorTime, previewLinks (data-preview-link) and mobileViewDistance (#301)
  • Added support for the sectnums AsciiDoc attribute (#185, #317)
  • Aligned our docinfo support to Asciidoctor Bespoke (#198, #324)
  • Support the highlightjs-languages attribute from Asciidocotor (#319, #320)
  • background-opacity title slide attribute renamed to title-slide-background-opacity (#323, #325)
  • Added support for the kdb macro to represent keyboard shortcuts (#276, #329)
  • Cosmetic improvements to callout lists (#335)

Bug Fixes

  • Line height CSS fix with code listing with line numbers (#331, #334)
  • Interactive debugging works again (#322)
  • Fixed Uncaught ReferenceError: require is not defined by dropping outdated documentation (#344)

Release meta

git tag | full diff | milestone

Credits

Thanks to the following people who contributed to this release:

Guillaume Grossetie, Thomas and Olivier Bilodeau

3.1.0 (2020-01-18)

Fixed a regression with Font-Awesome brand icons, added a JavaScript CLI and standalone executables for Windows, Linux and macOS.

Enhancements

  • We now provide native standalone executables for Windows, Linux and macOS using a Node to binary packager (#259, #308)
  • JavaScript stack now provides a CLI usable with npx asciidoctor-revealjs (#308)
  • Updated to Font-Awesome 5.12.0 (#305)
  • Ruby command line interface now shows Asciidoctor reveal.js version in addition to Asciidoctor version (#313)
  • Updated dependencies: rake
  • Better tests (#310, #311)

Bug Fixes

  • Added compatibility shim to Font Awesome 5 to fix brand icons rendering and more (#304, #305)

Release meta

  • Released on: 2020-01-18
  • Released by: Olivier Bilodeau
  • Release beer: Lupulus, Microbrasserie Charlevoix

git tag | full diff | milestone

Credits

Thanks to the following people who contributed to this release:

Guillaume Grossetie and Olivier Bilodeau

3.0.0 (2020-01-07)

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.

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 ( #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:

Benjamin Schmid, Daniel Mulholland, Eiji Onchi, Gérald Quintana, Guillaume Grossetie and Olivier Bilodeau

2.0.1 (2019-12-04)

Important Bug Fix

  • Fixed an issue that caused all reveal.js options in CamelCase to use the default value instead of one specified as an AsciiDoc attribute (#263, #267)

Compliance

  • Dropped support for verse table cells (#246). Asciidoctor 2.0 dropped it, we followed.

Enhancements

Bug Fixes

  • yarn.lock updates for security (#283)

Release meta

  • Released on: 2019-12-04
  • Released by: Olivier Bilodeau
  • Release whisky: Lot No. 40 Single Copper Pot Still Rye Whisky

git tag | full diff

Credits

Thanks to the following people who contributed to this release:

Benjamin Schmid, Guillaume Grossetie, Olivier Bilodeau

2.0.0 (2019-02-28)

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: Olivier Bilodeau
  • 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, Dan Allen, Guillaume Grossetie, Harald, Jakub Jirutka, Olivier Bilodeau, stevewillson, Vivien Didelot

1.1.3 (2018-01-31)

A repackage of 1.1.2 with a fix for Ruby 2.5 environments

Bug fixes

  • Worked around a problem in ruby-beautify with the compiled Slim template under Ruby 2.5

Release meta

  • Released on: 2018-01-31
  • Released by: Olivier Bilodeau
  • Release coffee: Santropol Dark Espresso

git tag | full diff

Credits

Thanks to the following people who contributed to this release:

Jakub Jirutka, Olivier Bilodeau

1.1.2 (2018-01-30)

NOTE: No packaged version of this release were produced.

A bugfix release due to a problem rendering tables using the Javascript / Node.js toolchain.

Enhancements

  • Documentation improvements (#181)

Bug fixes

  • Fixed crash with presentations with a table used from Javascript/Node.js setup (#178)

Release meta

  • Released on: 2018-01-30
  • Released by: Olivier Bilodeau
  • Release beer: A sad Belgian Moon in a Smoke Meat joint

git tag | full diff

Credits

Thanks to the following people who contributed to this release:

Guillaume Grossetie, Tobias Placht, Olivier Bilodeau

1.1.1 (2018-01-03)

An emergency bugfix release due to a problem in the Ruby Gem package

Enhancements

Compliance

  • Code listing callouts now work properly (#22, #166, #167)
  • More source code listing examples and tests (#163, #170)

Bug fixes

  • The version 1.1.0 Ruby Gem was broken due to a packaging error (#172)

Release meta

  • Released on: 2018-01-03
  • Released by: Olivier Bilodeau
  • Release beer: Croque-Mort Double IPA, À la fût

git tag | full diff | milestone

Credits

Thanks to the following people who contributed to this release:

Dietrich Schulten, Olivier Bilodeau

1.1.0 (2017-12-25) - @obilodeau

Enhancements

  • Support for Reveal.JS 3.5.0+ (#146, #151)
  • Support for Asciidoctor 1.5.6 (#132, #136, #142)
  • Support for Asciidoctor.js 1.5.6-preview.4 (#130, #143, #156)
  • Compiling slim templates to Ruby allows us to drop Jade templates for Asciidoctor.js users (#63, #131)
  • Documentation polish (#153, #158 and more)

Compliance

  • Users of Asciidoctor (Ruby) and Asciidoctor.js (Javascript) now run the same set of templates meaning that we achieved feature parity between the two implementations (#63, #131)

Bug fixes

Infrastructure

  • https://github.com/asciidoctor/asciidoctor-doctest[Asciidoctor-doctest] integration. This layer of automated testing should help prevent regressions and improve our development process. (#92, #116)
  • Travis-CI integration to automatically run doctests and examples AsciiDoc conversions
  • Travis-CI tests are triggered by changes done in Asciidoctor. We will detect upstream changes affecting us sooner.
  • Smoke tests for our Javascript / Node / Asciidoctor.js toolchain (integrated in Travis-CI also)
  • npm run examples will convert all examples using the Javascript / Node / Asciidoctor.js toolchain (#149)
  • rake examples:serve will run a Web server from examples/ so you can preview rendered examples (#154)

Release meta

git tag | full diff

Credits

Thanks to the following people who contributed to this release:

@jirutka, Dan Allen, Guillaume Grossetie, Jacob Aae Mikkelsen, Olivier Bilodeau, Rahul Somasunderam

1.0.4 (2017-09-27) - @obilodeau

Bug fixes

  • Dependency problems leading to crashes when used from Asciidoctor.js (#145)

Release meta

git tag | full diff

Credits

Thanks to the following people who contributed to this release:

Olivier Bilodeau, Guillaume Grossetie

1.0.3 (2017-08-28) - @obilodeau

Enhancements

  • Documentation improvements

Compliance

  • Added data-state: title to the title slide (#123)

Bug fixes

  • Pinned Asciidoctor version requirement to 1.5.4 to avoid dealing with #132 in the 1.0.x series
  • Fixed consistency issues with boolean values handling in revealjs settings (#125)

Release meta

git tag | full diff

Credits

Thanks to the following people who contributed to this release:

Dan Allen, nipa, Olivier Bilodeau, Pi3r

1.0.2 (2016-12-22) - @obilodeau

Enhancements

  • Ruby back-end is now compiled in Javascript with Opal (#115)
  • Documentation improvements

Release meta

issues resolved | git tag | full diff

Credits

Thanks to the following people who contributed to this release:

Dan Allen, Guillaume Grossetie, Olivier Bilodeau

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

Release meta

Released by @obilodeau

issues resolved | git tag | full diff

Credits

Thanks to the following people who contributed to this release:

Olivier Bilodeau

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.

Enhancements

  • Initial release
  • Ruby package (#93)
  • Node package (#95)
  • :customcss: attribute for easy per-presentation CSS (#85)
  • Video support improvements (#81)
  • Reveal.js data-state support (#61)
  • Subtitle partioning (#70)
  • Background image rework (#52)
  • :imagesdir: properly enforced (#17, #67)

Release meta

Released by @obilodeau

issues resolved | git tag

Credits

Thanks to the following people who contributed to this release:

Alexander Heusingfeld, Andrea Bedini, Antoine Sabot-Durand, Brian Street, Charles Moulliard, Dan Allen, Danny Hyun, Emmanuel Bernard, gtoast, Guillaume Grossetie, Jacob Aae Mikkelsen, Jakub Jirutka, Jozef Skrabo, Julien Grenier, Julien Kirch, kubamarchwicki, lifei, Nico Rikken, nipa, Olivier Bilodeau, Patrick van Dissel, phrix32, Rahman Usta, Robert Panzer, Rob Winch, Thomas and Wendell Smith