@asciidoctor/core 3.0.0-alpha.3 → 3.0.0-rc.1

package/README.md

@@ -0,0 +1,51 @@
+# Asciidoctor core
+
+This package provides Asciidoctor core functionality:
+
+* parser
+* built-in converters
+* extensions
+
+## Install
+
+```console
+$ npm i @asciidoctor/core --save
+```
+
+## Usage
+
+Here is a simple example that converts AsciiDoc to HTML5:
+
+**sample.js**
+
+```javascript
+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:
+
+```console
+$ node sample.js
+```
+
+You should see the following output in your terminal:
+
+```html
+<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](https://asciidoctor-docs.netlify.com/asciidoctor.js/).
+
+## Changelog
+
+Refer to the [CHANGELOG](https://github.com/asciidoctor/asciidoctor.js/blob/main/CHANGELOG.adoc) for a complete list of changes.