HACKING.adoc in asciidoctor-revealjs-1.0.3 vs HACKING.adoc in asciidoctor-revealjs-1.0.4
- old
+ new
@@ -206,14 +206,19 @@
In order to test the Node package, you need to create a test project adjacent to the clone of the `asciidoctor-reveal.js` repository:
$ mkdir test-project
$ cd test-project
- $ npm init -y
-Now, install the dependencies:
+Now, install the dependencies.
- $ npm i --save asciidoctor.js@1.5.5-3
+WARNING: It is important to track `Asciidoctor.js`, `Asciidoctor-template.js` and `bestikk-opal-compiler` versions all together.
+The `opal-compiler` used to compile our node package must match `asciidoctor.js` `opal-runtime`.
+The first one is explicitly installed by users on install and the two later are specified in our `package.json`.
+When you update one remember to update the others.
+Versions known to work together can be found here, just replace <tag> with the `asciidoctor.js` release you are interested in: https://github.com/asciidoctor/asciidoctor.js/blob/<tag>/package.json
+
+ $ npm i --save asciidoctor.js@1.5.5-5
$ npm i --save ../asciidoctor-reveal.js
NOTE: The relative portion of the last command is where you are installing the local `asciidoctor-reveal.js` version from.
Then proceed as documented in the `README.adoc`.