Skip to content
This repository has been archived by the owner on Apr 29, 2020. It is now read-only.

Commit

Permalink
Resolves #1, List backends supported
Browse files Browse the repository at this point in the history
  • Loading branch information
ggrossetie committed Oct 1, 2016
1 parent abdeea8 commit ac11235
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
# Generic template backend for Asciidoctor.js
Guillaume Grossetie <https://github.com/mogztter[@mogztter]>
:uri-asciidoctorjs-repo: https://github.com/asciidoctor/asciidoctor.js
:uri-jade-repo: https://github.com/pugjs/pug/tree/1.11.0
:uri-repo: https://github.com/asciidoctor/asciidoctor-template.js

## Usage

The {uri-repo}[`asciidoctor-template.js`] is a template backend for {uri-asciidoctorjs-repo}[Asciidoctor.js] based on {uri-jade-repo}[Jade] template engine.

Here’s the list of currently supported backends:

* <<revealjs>>
[[revealjs]]
### Reveal.js

In this example we are using the https://github.com/asciidoctor/asciidoctor-reveal.js[Reveal.js backend]:

```
npm install asciidoctor.js
npm install asciidoctor-reveal.js
```

IMPORTANT: `asciidoctor-reveal.js` and `asciidoctor-template.js` are not yet available on npmjs.com

```javascript
var asciidoctor = require('asciidoctor.js')();
var Asciidoctor = asciidoctor.Asciidoctor();
Expand Down

0 comments on commit ac11235

Please sign in to comment.