CHANGELOG.adoc in asciidoctor-revealjs-3.1.0 vs CHANGELOG.adoc in asciidoctor-revealjs-4.0.0

- old
+ new

@@ -4,9 +4,95 @@ :uri-issue: {uri-repo}/issues/ This document provides a high-level view of the changes introduced in {project-name} by release. For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub. + +== 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](https://github.com/asciidoctor/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 {uri-issue}301[#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 {uri-issue}323[#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 {uri-issue}326[#326] and PR {uri-issue}332[#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 {uri-issue}320[#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 https://github.com/asciidoctor/asciidoctor-reveal.js#supplemental-content-with-docinfo[here] and the related tickets are {uri-issue}198[#198] and {uri-issue}324[#324]. + * Default highlight.js theme is monokai. This follows a reveal.js change. + +Enhancements:: + * New _Columns layout_ feature which provides easy to use roles to create multiple columns in slides. + See the https://github.com/asciidoctor/asciidoctor-reveal.js#columns-layout[feature's documentation] for usage details. + See issue {uri-issue}326[#326] and PRs {uri-issue}332[#332], {uri-issue}340[#340] for details. + * Built-in slim templates can now be overridden with `--template-dir` or `-T` ({uri-issue}177[#177], {uri-issue}318[#318]) + * Highlight.js is now bundled by us instead of reveal.js. + You can add other languages not supported in the core set by using the `highlightjs-languages` attribute. + It can also be loaded locally or from a CDN of your choice. + See issues {uri-issue}21[#21], {uri-issue}319[#319] and {uri-issue}320[#320] for details. + * We now support the Java / JVM ecosystem. + This packaging happens in a separate project: https://github.com/asciidoctor/asciidoctorj-reveal.js[AsciidoctorJ reveal.js]. + See issue {uri-issue}271[#217] and PR {uri-issue}337[#337] for details. + * Many new examples demonstrating various features + * Documentation improvements ({uri-issue}322[#322]) + * Refactoring ({uri-issue}327[#327], {uri-issue}330[#330], {uri-issue}333[#333]) + +Compliance:: + * New reveal.js 3.8.0 and 3.9.0 features supported ({uri-issue}301[#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` ({uri-issue}301[#301]) + * Added support for the `sectnums` AsciiDoc attribute ({uri-issue}185[#185], {uri-issue}317[#317]) + * Aligned our `docinfo` support to Asciidoctor Bespoke ({uri-issue}198[#198], {uri-issue}324[#324]) + * Support the `highlightjs-languages` attribute from Asciidocotor ({uri-issue}319[#319], {uri-issue}320[#320]) + * `background-opacity` title slide attribute renamed to `title-slide-background-opacity` ({uri-issue}323[#323], {uri-issue}325[#325]) + * Added support for the `kdb` macro to represent keyboard shortcuts ({uri-issue}276[#276], {uri-issue}329[#329]) + * Cosmetic improvements to callout lists ({uri-issue}335[#335]) + +Bug Fixes:: + * Line height CSS fix with code listing with line numbers ({uri-issue}331[#331], {uri-issue}334[#334]) + * Interactive debugging works again ({uri-issue}322[#322]) + * Fixed _Uncaught ReferenceError: require is not defined_ by dropping outdated documentation ({uri-issue}344[#344]) + +=== Release meta + +* Released on: 2020-02-18 +* Released by: Olivier Bilodeau +* Release drink: https://defi.leclub28.com/en/p/47E2C422178348F[Lime Flavored Sparkling Water] + +{uri-repo}/releases/tag/v4.0.0[git tag] | +{uri-repo}/compare/v3.1.0...v4.0.0[full diff] | +{uri-repo}/milestone/8[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::