= 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
[source,javascript]
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:
[source,html]
----
If you want to know more about Asciidoctor.js, please read the https://asciidoctor-docs.netlify.com/asciidoctor.js/[User Manual].
== Changelog
Refer to the https://github.com/asciidoctor/asciidoctor.js/blob/main/CHANGELOG.adoc[CHANGELOG] for a complete list of changes.