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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.adoc DELETED
@@ -1,48 +0,0 @@
1
- = Asciidoctor core
2
-
3
- This package provides Asciidoctor core functionality:
4
-
5
- - parser
6
- - built-in converters
7
- - extensions
8
-
9
- == Install
10
-
11
- $ npm i @asciidoctor/core --save
12
-
13
- == Usage
14
-
15
- Here is a simple example that converts AsciiDoc to HTML5:
16
-
17
- .sample.js
18
- [source,javascript]
19
- ----
20
- const asciidoctor = require('@asciidoctor/core')() // <1>
21
- const content = 'http://asciidoctor.org[*Asciidoctor*] ' +
22
- 'running on https://opalrb.com[_Opal_] ' +
23
- 'brings AsciiDoc to Node.js!'
24
- const html = asciidoctor.convert(content) // <2>
25
- console.log(html) // <3>
26
- ----
27
- <1> Instantiate the Asciidoctor.js library
28
- <2> Convert AsciiDoc content to HTML5 using Asciidoctor.js
29
- <3> Print the HTML5 output to the console
30
-
31
- Save the file as _sample.js_ and run it using the `node` command:
32
-
33
- $ node sample.js
34
-
35
- You should see the following output in your terminal:
36
-
37
- [source,html]
38
- ----
39
- <div class="paragraph">
40
- <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>
41
- </div>
42
- ----
43
-
44
- If you want to know more about Asciidoctor.js, please read the https://asciidoctor-docs.netlify.com/asciidoctor.js/[User Manual].
45
-
46
- == Changelog
47
-
48
- Refer to the https://github.com/asciidoctor/asciidoctor.js/blob/main/CHANGELOG.adoc[CHANGELOG] for a complete list of changes.