Releases: asciidoctor/asciidoctor-reveal.js
v2.0.0
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
andmarkdown
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 afloat: 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
, newslideNumber
formats,showSlideNumber
,autoSlideMethod
,parallaxBackgroundHorizontal
,parallaxBackgroundVertical
anddisplay
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::
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
v1.1.3
A repackage of 1.1.2 with a fix for Ruby 2.5 environments
Distribution
Changelog
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: @obilodeau
- Release coffee: Santropol Dark Espresso
Credits
Thanks to the following people who contributed to this release:
v1.1.2
NOTE: No packaged version of this release were produced.
A bugfix release due to a problem rendering tables using the Javascript / Node.js toolchain
Changelog
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: @obilodeau
- Release beer: A sad Belgian Moon in a Smoke Meat joint
Credits
Thanks to the following people who contributed to this release:
@toplac, @Mogztter, @obilodeau
v1.1.1
An emergency bugfix release due to a problem in the Ruby Gem package
Distribution
Changelog
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: @obilodeau
- 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:
v1.1.0
A big release with a lot of testing improvements and alignment between our Ruby and Javascript stacks. Converting AsciiDoc to HTML/Reveal.js now works using the same template code for both Asciidoctor (Ruby) and Asciidoctor.js (Javascript)!
Distribution
Changelog
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
- Reveal.js history feature now works. We are working around Reveal.js' section id character limits. (#127, #150, hakimel/reveal.js#1346)
Infrastructure
- 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 fromexamples/
so you can preview rendered examples (#154)
Release meta
Released on: 2017-12-25
Released by: @obilodeau
Release beer: Krakhan Double IPA, Brasserie du Bois Blanc
Credits
Thanks to the following people who contributed to this release:
@jirutka, Dan Allen, Guillaume Grossetie, Jacob Aae Mikkelsen, Olivier Bilodeau, Rahul Somasunderam
v1.0.4
Emergency release to fix a dependency problem when using from Javascript / Asciidoctor.js
Distribution
Changelog
Bug fixes
- Dependency problems leading to crashes when used from Asciidoctor.js (#145)
Release meta
Released on: 2018-09-27
Released by: @obilodeau
Release beer: Cape May Coastal Evacuation Double IPA
Credits
Thanks to the following people who contributed to this release:
Olivier Bilodeau, Guillaume Grossetie
v1.0.3
Future proofing the 1.0.x series
Distribution
Changelog
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
Released on: 2018-08-28
Released by: @obilodeau
Release beer: Boulevard Tank 7 Farmhouse Ale
Credits
Thanks to the following people who contributed to this release:
Dan Allen, nipa, Olivier Bilodeau, Pi3r
v1.0.2
Fixing broken npm package
Distribution
Changelog
Enhancements
- Ruby back-end is now compiled in Javascript with Opal (#115)
Release meta
Released on: 2016-12-22
Released by: @obilodeau
Release beer: Brasseurs du monde's Houblonnière Douple IPA
v1.0.1
Aligned npm and rubygem package versions
Distribution
Changelog
Enhancements
- Documentation: aligned release process for both npm and ruby gems packages
- npm package in sync with ruby gem
Release meta
Released on: 2016-10-12
Released by: @obilodeau
Release beer: Unibroue La Fin du Monde
v1.0.0
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.
Distribution
Changelog
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 on: 2016-10-06
Released by: @obilodeau
Release beer: Les Trois Mousquetaires Maibock
Credits
Thanks to the following people who contributed to this first 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