= Asciidoctor.js: AsciiDoc in JavaScript powered by Asciidoctor Dan Allen https://github.com/mojavelinux[@mojavelinux]; Guillaume Grossetie https://github.com/mogztter[@mogztter]; Anthonny Quérouil https://github.com/anthonny[@anthonny] :idprefix: :idseparator: - :uri-nodejs: https://nodejs.org :uri-opal: https://opalrb.com :uri-repo: https://github.com/asciidoctor/asciidoctor.js :uri-freesoftware: https://www.gnu.org/philosophy/free-sw.html ifndef::uri-rel-file-base[:uri-rel-file-base: link:] :uri-contribute: {uri-rel-file-base}CONTRIBUTING.adoc :uri-contribute-code: {uri-rel-file-base}CONTRIBUTING-CODE.adoc :uri-user-manual: https://docs.asciidoctor.org/asciidoctor.js/latest/ :license: {uri-repo}/blob/main/LICENSE :experimental: :endash:
ifdef::env-github[] image:https://github.com/asciidoctor/asciidoctor.js/workflows/Build/badge.svg[GitHub Actions Status, link=https://github.com/asciidoctor/asciidoctor.js/actions] image:https://img.shields.io/npm/v/asciidoctor.svg[npm version, link=https://www.npmjs.org/package/asciidoctor] image:https://img.shields.io/npm/dm/asciidoctor[npm stats, link=https://www.npmjs.org/package/asciidoctor] image:https://img.shields.io/badge/jsdoc-main-blue.svg[JSDoc, link=https://asciidoctor.github.io/asciidoctor.js/main] image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg[project chat,link=https://asciidoctor.zulipchat.com/] endif::[]
Asciidoctor.js brings AsciiDoc to the JavaScript world!
This project uses {uri-opal}[Opal] to transpile http://asciidoctor.org[Asciidoctor], a modern implementation of AsciiDoc, from Ruby to JavaScript to produce asciidoctor.js. The asciidoctor.js script 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:
import asciidoctor from 'asciidoctor' // <1>
Asciidoctor running on Opal brings AsciiDoc to Node.js!