Skip to content

Commit

Permalink
doc: achieve npm package compatibility now and in the future (#187)
Browse files Browse the repository at this point in the history
Looks like this could work to address the Opal dependency problem.
  • Loading branch information
obilodeau committed Jan 7, 2020
1 parent a22a639 commit 96845f1
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 3 deletions.
4 changes: 2 additions & 2 deletions HACKING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,8 @@ Asciidoctor.js maintainer told us that he is going to consider binary package in

We will track and maintain the README on the major version supported and recommended:

* In the version range to install by default for a given release (and on master)
* In the compatibility matrix
* In the link:README.adoc#node-install[version range to install by default] for a given release (and on master)
* In the link:README.adoc#asciidoctorjs-compatibility-matrix[compatibility matrix]

See https://github.com/asciidoctor/asciidoctor-reveal.js/issues/187#issuecomment-570771473[this issue] for background details on that topic.

Expand Down
27 changes: 26 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ TIP: If you are using https://pages.github.com/[GitHub Pages], plan ahead by kee

First you must install and configure {uri-nodejs-download}[Node] on your machine.

[[node-install]]
=== Install

We recommend to install the dependencies in a project directory, such as the directory where your AsciiDoc presentations are stored.
Expand All @@ -143,7 +144,7 @@ If you don't have a `package.json` file in your project directory, you can creat

You can now install the dependencies:

$ npm i --save asciidoctor @asciidoctor/reveal.js
$ npm i --save asciidoctor@^2.0 @asciidoctor/reveal.js

=== Convert AsciiDoc into slides

Expand Down Expand Up @@ -1004,6 +1005,30 @@ If you need more details about our dependencies check out Asciidoctor dependenci
* With Ruby / Bundler: https://github.com/asciidoctor/asciidoctor/tree/v2.0.10#requirements[Asciidoctor] 2.0.10
* With JavaScript (Node.js) / NPM: https://github.com/asciidoctor/asciidoctor.js/blob/v2.0.3/packages/core/package.json[Asciidoctor.js] 2.0.3

[[asciidoctorjs-compatibility-matrix]]
== Asciidoctor.js Compatibility Matrix

NOTE: This section is intended only for more advanced users who combine extensions or maintain slide decks over many releases and need to update their dependencies.

Due to our Ruby to JavaScript conversion process, published npm packages have strict requirements with which version of Asciidoctor.js they are compatible with.
This table tracks this compatibility.

|===
|Asciidoctor-reveal.js version |Asciidoctor.js version

|3.x
|2.x

|2.x
|1.5.9

|1.1.x
|1.5.6-preview.4
|===

Be aware that it is always possible to recompile the converter into JavaScript from source so compatibility can be created by anyone if needed.
More details on that topic can be found link:HACKING.adoc#node-binary-compatibility[in the development guide].


== Showcase Presentations

Expand Down

0 comments on commit 96845f1

Please sign in to comment.