JSPM

  • Created
  • Published
  • Downloads 90486
  • Score
    100M100P100Q151885F
  • License MIT

Asciidoctor - the core library

Package Exports

  • @asciidoctor/core

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@asciidoctor/core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Asciidoctor core

This package provides Asciidoctor core functionality:

  • parser
  • built-in converters
  • extensions

Install

$ npm i @asciidoctor/core --save

Usage

Here is a simple example that converts AsciiDoc to HTML5:

sample.js

const asciidoctor = require('@asciidoctor/core')() // <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>

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

Changelog

Refer to the CHANGELOG for a complete list of changes.