asciidoctor 3.0.0-alpha.2 → 3.0.0-alpha.4
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.md +18 -12
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -7,7 +7,9 @@ The _asciidoctor.js_ script can be run on any JavaScript platform, including Nod
|
|
|
7
7
|
|
|
8
8
|
## Install
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
```console
|
|
11
|
+
$ npm i asciidoctor --save
|
|
12
|
+
```
|
|
11
13
|
|
|
12
14
|
## Usage
|
|
13
15
|
|
|
@@ -16,20 +18,24 @@ Here is a simple example that converts AsciiDoc to HTML5:
|
|
|
16
18
|
**sample.js**
|
|
17
19
|
|
|
18
20
|
```javascript
|
|
19
|
-
|
|
21
|
+
import asciidoctor from 'asciidoctor'
|
|
22
|
+
|
|
23
|
+
const Asciidoctor = asciidoctor() // ①
|
|
20
24
|
const content = 'http://asciidoctor.org[*Asciidoctor*] ' +
|
|
21
25
|
'running on https://opalrb.com[_Opal_] ' +
|
|
22
26
|
'brings AsciiDoc to Node.js!'
|
|
23
|
-
const html =
|
|
24
|
-
console.log(html) //
|
|
27
|
+
const html = Asciidoctor.convert(content) // ②
|
|
28
|
+
console.log(html) // ③
|
|
25
29
|
```
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
30
|
+
1. Instantiate the Asciidoctor.js library
|
|
31
|
+
2. Convert AsciiDoc content to HTML5 using Asciidoctor.js
|
|
32
|
+
3. Print the HTML5 output to the console
|
|
29
33
|
|
|
30
34
|
Save the file as _sample.js_ and run it using the `node` command:
|
|
31
35
|
|
|
32
|
-
|
|
36
|
+
```console
|
|
37
|
+
$ node sample.js
|
|
38
|
+
```
|
|
33
39
|
|
|
34
40
|
You should see the following output in your terminal:
|
|
35
41
|
|
|
@@ -39,12 +45,12 @@ You should see the following output in your terminal:
|
|
|
39
45
|
</div>
|
|
40
46
|
```
|
|
41
47
|
|
|
42
|
-
If you want to know more about Asciidoctor.js, please read the [User Manual](https://
|
|
48
|
+
If you want to know more about Asciidoctor.js, please read the [User Manual](https://docs.asciidoctor.org/asciidoctor.js/latest/).
|
|
43
49
|
|
|
44
50
|
## Contributing
|
|
45
51
|
|
|
46
52
|
In the spirit of [free software](https://www.gnu.org/philosophy/free-sw.html), _everyone_ is encouraged to help improve this project.
|
|
47
|
-
If you discover errors or omissions in the source code, documentation, or website content, please don
|
|
53
|
+
If you discover errors or omissions in the source code, documentation, or website content, please don’t hesitate to submit an issue or open a pull request with a fix.
|
|
48
54
|
New contributors are always welcome!
|
|
49
55
|
|
|
50
56
|
The [Contributing](https://github.com/asciidoctor/asciidoctor.js/blob/main/CONTRIBUTING.adoc) guide provides information on how to contribute.
|
|
@@ -53,7 +59,7 @@ If you want to write code, the [Contributing Code](https://github.com/asciidocto
|
|
|
53
59
|
|
|
54
60
|
## Copyright
|
|
55
61
|
|
|
56
|
-
Copyright (C)
|
|
62
|
+
Copyright (C) 2013-present Dan Allen, Guillaume Grossetie, Anthonny Quérouil and the Asciidoctor Project.
|
|
57
63
|
Free use of this software is granted under the terms of the MIT License.
|
|
58
64
|
|
|
59
|
-
See the [LICENSE](https://github.com/asciidoctor/asciidoctor.js/blob/main/LICENSE) file for details.
|
|
65
|
+
See the [LICENSE](https://github.com/asciidoctor/asciidoctor.js/blob/main/LICENSE) file for details.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "asciidoctor",
|
|
3
|
-
"version": "3.0.0-alpha.
|
|
3
|
+
"version": "3.0.0-alpha.4",
|
|
4
4
|
"description": "A JavaScript AsciiDoc processor, cross-compiled from the Ruby-based AsciiDoc implementation, Asciidoctor, using Opal",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"types": "types",
|
|
@@ -46,9 +46,9 @@
|
|
|
46
46
|
"homepage": "https://github.com/asciidoctor/asciidoctor.js",
|
|
47
47
|
"dependencies": {
|
|
48
48
|
"@asciidoctor/cli": "3.5.0",
|
|
49
|
-
"@asciidoctor/core": "3.0.0-alpha.
|
|
49
|
+
"@asciidoctor/core": "3.0.0-alpha.4"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
|
-
"pkg": "
|
|
52
|
+
"pkg": "5.8.0"
|
|
53
53
|
}
|
|
54
54
|
}
|