@asciidoctor/core
TypeScript icon, indicating that this package has built-in type declarations

3.0.4 • Public • Published

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')() // ①
const content = 'http://asciidoctor.org[*Asciidoctor*] ' +
  'running on https://opalrb.com[_Opal_] ' +
  'brings AsciiDoc to Node.js!'
const html = asciidoctor.convert(content) // ②
console.log(html) // ③
  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.

/@asciidoctor/core/

    Package Sidebar

    Install

    npm i @asciidoctor/core

    Weekly Downloads

    47,674

    Version

    3.0.4

    License

    MIT

    Unpacked Size

    6.39 MB

    Total Files

    10

    Last publish

    Collaborators

    • mojavelinux
    • ggrossetie
    • obilodeau