Skip to content

Commit

Permalink
Update install instruction to run Asciidoctor Reveal.js with Asciidoc…
Browse files Browse the repository at this point in the history
…tor.js
  • Loading branch information
ggrossetie committed Sep 5, 2017
1 parent 65c57a3 commit 3e9ede2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
3 changes: 1 addition & 2 deletions HACKING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -207,14 +207,13 @@ In order to test the Node package, you need to create a test project adjacent to

Now, install the dependencies:

$ npm i --save asciidoctor.js@1.5.5-3
$ npm i --save asciidoctor.js@1.5.6-preview.3
$ 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`.


== Release process

. Update the version in `lib/asciidoctor-revealjs/version.rb` and `package.json`
Expand Down
8 changes: 3 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -133,14 +133,12 @@ Here we are converting a file named `presentation.adoc` into a reveal.js present
----
// Load asciidoctor.js and asciidoctor-reveal.js
var asciidoctor = require('asciidoctor.js')();
var Asciidoctor = asciidoctor.Asciidoctor();
require('asciidoctor-reveal.js');
// Convert the document 'presentation.adoc' using the reveal.js converter
var attributes = 'revealjsdir=node_modules/reveal.js@';
var attributes = {'revealjsdir': 'node_modules/reveal.js@'};
var options = {safe: 'safe', backend: 'revealjs', attributes: attributes};
Asciidoctor.convertFile('presentation.adoc', options); // <1>
asciidoctor.convertFile('presentation.adoc', options); // <1>
----
<1> Creates a file named `presentation.html` (in the directory where command is run)

Expand All @@ -162,7 +160,7 @@ Asciidoctor.convertFile('presentation.adoc', options); // <1>

To render the slides, run:

node asciidoctor-reveal.js
node asciidoctor-revealjs.js

You can open the `presentation.html` file in your browser and enjoy!

Expand Down

0 comments on commit 3e9ede2

Please sign in to comment.