Skip to content
A JavaScript port of Asciidoctor, a modern implementation of AsciiDoc
JavaScript TypeScript Ruby HTML Shell Java
Branch: master
Clone or download
Mogztter 👷 resolves #809 fix the test:graalvm task on macOS (#840)
- run on GitHub Actions
- download the GraalVM darwin package
- execute the java, javac and node command from the correct path
Latest commit 41b4fe0 Feb 2, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github 👷 resolves #809 fix the test:graalvm task on macOS (#840) Feb 2, 2020
docs
packages 👷 resolves #809 fix the test:graalvm task on macOS (#840) Feb 2, 2020
scripts 👷 Add GitHub actions to build (Linux) and notify (#834) Feb 2, 2020
spec/build 💥 Rename asciidoctor.js to asciidoctor (#694) Mar 22, 2019
tasks
.editorconfig Create a wrapper API around Asciidoctor.js Oct 2, 2016
.gitignore 💥 Rename asciidoctor.js to asciidoctor (#694) Mar 22, 2019
.travis-upstream-only.yml ⬆️ Build against the latest release of Asciidoctor 2.0.10 (#808) Jan 16, 2020
.travis.yml 👷 Keep .dts directory to workaround an issue with npm/Travis (#842) Feb 2, 2020
CHANGELOG.adoc 📝 Prepare the changelog for the next release Feb 2, 2020
CONTRIBUTING-CODE.adoc ⬆️ Build against the latest release of Asciidoctor 2.0.10 (#808) Jan 16, 2020
CONTRIBUTING.adoc add an inspiring and welcoming intro to CONTRIBUTING.adoc Jul 4, 2015
LICENSE 🎉 Update license year Mar 20, 2019
README.adoc
appveyor.yml 💥 Rename asciidoctor.js to asciidoctor (#694) Mar 22, 2019
error-in-chrome-console.png document how to debug errors using browser console Oct 22, 2013
error-in-javascript-debugger.png document how to debug errors using browser console Oct 22, 2013
package-lock.json 🔒 npm audit fix Dec 28, 2019
package.json 💥 Rename asciidoctor.js to asciidoctor (#694) Mar 22, 2019

README.adoc

Asciidoctor.js: AsciiDoc in JavaScript powered by Asciidoctor

GitHub Actions Status Travis build status Appveyor build status npm version jsDelivr stats JSDoc InchCI

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.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:

sample.js
const asciidoctor = require('asciidoctor')() // (1)
const content = 'http://asciidoctor.org[*Asciidoctor*] ' +
  'running on https://opalrb.com[_Opal_] ' +
  'brings AsciiDoc to Node.js!'
const html = asciidoctor.convert(content) // (2)
console.log(html) // (3)
  1. Instantiate the Asciidoctor.js library

  2. Convert AsciiDoc content to HTML5 using Asciidoctor.js

  3. Print the HTML5 output to the console

Save the file as sample.js and run it using the node command:

$ node sample.js

You should see the following output in your terminal:

<div class="paragraph">
<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>
</div>

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

<script src="node_modules/@asciidoctor/core/dist/browser/asciidoctor.js"></script>

Learning

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

Contributing

In the spirit of free software, everyone is 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 © 2020 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.

You can’t perform that action at this time.