Asciidoctor.js

A JavaScript port of Asciidoctor, a modern implementation of AsciiDoc

Markup language
asciidoctor/asciidoctor.jsasciidoctor.orgasciidoctor

README

Asciidoctor.js: AsciiDoc in JavaScript powered by Asciidoctor


Asciidoctor.js brings AsciiDoc to the JavaScript world!

This project uses Opal to transpile Asciidoctor , a modern implementation of AsciiDoc, from Ruby to JavaScript to produce asciidoctor.js. The asciidoctor.jsscript can be run on any JavaScript platform, including Node.js, GraalVM and, of course, a web browser.

Quickstart


$ npm i asciidoctor --save

Here is a simple example that converts AsciiDoc to HTML5:

sample.js

  1. ``` js
  2. import asciidoctor from 'asciidoctor' // (1)

  4. const Asciidoctor = asciidoctor()
  5. const content = 'http://asciidoctor.org[*Asciidoctor*] ' +
  6.   'running on https://opalrb.com[_Opal_] ' +
  7.   'brings AsciiDoc to Node.js!'
  8. const html = Asciidoctor.convert(content) // (2)
  9. console.log(html) // (3)
  10. ```

Instantiate the Asciidoctor.js library

Convert AsciiDoc content to HTML5 using Asciidoctor.js

Print the HTML5 output to the console

Save the file as sample.jsand run it using the nodecommand:

$ node sample.js

You should see the following output in your terminal:

  1. ``` html
  2. <div class="paragraph">
  3. <p><a href="http://asciidoctor.org"><strong>Asciidoctor</strong></a> running on <a href="http://opalrb.com"><em>Opal</em></a> brings AsciiDoc to Node.js!</p>
  4. </div>
  5. ```

It’s also possible to use the following scripttag directly into your HTML page:

  1. ``` html
  2. <script src="node_modules/@asciidoctor/core/dist/browser/asciidoctor.js"></script>
  3. ```

Learning


If you want to learn more about Asciidoctor.js, please read the User Manual .

Contributing


In the spirit of free software , everyoneis encouraged to help improve this project. If you discover errors or omissions in the source code, documentation, or website content, please don’t hesitate to submit an issue or open a pull request with a fix.
New contributors are always welcome!

The Contributing guide provides information on how to contribute.

If you want to write code, the Contributing Code guide will help you to get started quickly.

Copyright


Copyright © 2013-present Dan Allen, Guillaume Grossetie, Anthonny Quérouil and the Asciidoctor Project. Free use of this software is granted under the terms of the MIT License.

See the LICENSE file for details.

Changelog


Refer to the CHANGELOG for a complete list of changes.