@antora/cli 3.0.0-beta.4 → 3.0.0-rc.2
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 +5 -3
- package/lib/cli.js +1 -1
- package/package.json +9 -8
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Antora CLI
|
|
2
2
|
|
|
3
3
|
The command line interface (CLI) for Antora.
|
|
4
|
+
This package provides the `antora` command (i.e., bin script) to run Antora.
|
|
5
|
+
It does not include the site generator, which must be installed separately.
|
|
4
6
|
|
|
5
7
|
[Antora](https://antora.org) is a modular static site generator designed for creating documentation sites from AsciiDoc documents.
|
|
6
8
|
Its site generator aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
|
|
@@ -13,7 +15,7 @@ Once these packages are installed, you can use the `antora` command to generate
|
|
|
13
15
|
Let's start by installing the CLI.
|
|
14
16
|
|
|
15
17
|
```sh
|
|
16
|
-
npm
|
|
18
|
+
npm i -g @antora/cli
|
|
17
19
|
```
|
|
18
20
|
|
|
19
21
|
This package adds the `antora` command to your PATH.
|
|
@@ -27,7 +29,7 @@ Next, install a site generator.
|
|
|
27
29
|
The site generator provided by Antora will be sufficient for most users.
|
|
28
30
|
|
|
29
31
|
```sh
|
|
30
|
-
npm
|
|
32
|
+
npm i -g @antora/site-generator
|
|
31
33
|
```
|
|
32
34
|
|
|
33
35
|
The `antora` command (specifically the implicit `generate` subcommand) will look for this package by default.
|
|
@@ -37,7 +39,7 @@ The `antora` command (specifically the implicit `generate` subcommand) will look
|
|
|
37
39
|
To run Antora, you'll need a playbook file and at least one content (source) repository.
|
|
38
40
|
Consult the [quickstart](https://docs.antora.org/antora/latest/install-and-run-quickstart/) to find an example.
|
|
39
41
|
|
|
40
|
-
Once you have your content sources set up,
|
|
42
|
+
Once you have your content sources set up, point the `antora` command at your playbook file:
|
|
41
43
|
|
|
42
44
|
```sh
|
|
43
45
|
antora antora-playbook.yml
|
package/lib/cli.js
CHANGED
|
@@ -35,7 +35,7 @@ function exitWithError (err, opts, msg = undefined) {
|
|
|
35
35
|
function exit () {
|
|
36
36
|
return requireLogger()
|
|
37
37
|
.finalizeLogger()
|
|
38
|
-
.then((failOnExit) => process.
|
|
38
|
+
.then((failOnExit) => process.exitCode || (process.exitCode = failOnExit ? 1 : 0))
|
|
39
39
|
}
|
|
40
40
|
|
|
41
41
|
function getTTYColumns () {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@antora/cli",
|
|
3
|
-
"version": "3.0.0-
|
|
3
|
+
"version": "3.0.0-rc.2",
|
|
4
4
|
"description": "The command line interface for Antora.",
|
|
5
5
|
"license": "MPL-2.0",
|
|
6
6
|
"author": "OpenDevise Inc. (https://opendevise.com)",
|
|
@@ -17,18 +17,20 @@
|
|
|
17
17
|
"bin": {
|
|
18
18
|
"antora": "bin/antora"
|
|
19
19
|
},
|
|
20
|
+
"scripts": {
|
|
21
|
+
"test": "_mocha"
|
|
22
|
+
},
|
|
20
23
|
"dependencies": {
|
|
21
|
-
"@antora/logger": "3.0.0-
|
|
22
|
-
"@antora/playbook-builder": "3.0.0-
|
|
24
|
+
"@antora/logger": "3.0.0-rc.2",
|
|
25
|
+
"@antora/playbook-builder": "3.0.0-rc.2",
|
|
23
26
|
"@antora/user-require-helper": "~2.0",
|
|
24
27
|
"commander": "~8.3"
|
|
25
28
|
},
|
|
26
29
|
"devDependencies": {
|
|
27
|
-
"@antora/site-publisher": "3.0.0-
|
|
30
|
+
"@antora/site-publisher": "3.0.0-rc.2",
|
|
28
31
|
"@asciidoctor/core": "~2.2",
|
|
29
32
|
"convict": "~6.2",
|
|
30
|
-
"kapok-js": "~0.10"
|
|
31
|
-
"node-git-server": "~0.6"
|
|
33
|
+
"kapok-js": "~0.10"
|
|
32
34
|
},
|
|
33
35
|
"engines": {
|
|
34
36
|
"node": ">=12.21.0"
|
|
@@ -45,6 +47,5 @@
|
|
|
45
47
|
"static site",
|
|
46
48
|
"web publishing"
|
|
47
49
|
],
|
|
48
|
-
"gitHead": "
|
|
49
|
-
"readmeFilename": "README.md"
|
|
50
|
+
"gitHead": "b64861391b7e55ea31fcecce4490b9cc02fec1c7"
|
|
50
51
|
}
|