You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/cli.adoc
+23-4Lines changed: 23 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,11 @@
3
3
:url-chocolatey: https://chocolatey.org
4
4
:url-sdkman: https://sdkman.io
5
5
6
-
There are two basic ways to make AsciidoctorJ available as a command line tool.
6
+
There are three basic ways to make AsciidoctorJ available as a command line tool.
7
7
8
8
* Manual installation using the binary distribution.
9
-
* Automatic installation using a package manager like {url-sdkman}[SDKMAN^] or {url-chocolatey}[Chocolatey^].
9
+
* Automated installation using a package manager like {url-sdkman}[SDKMAN^] or {url-chocolatey}[Chocolatey^].
10
+
* Directly running AsciidoctorJ using JBang.
10
11
11
12
== Manual distribution installation
12
13
@@ -48,15 +49,17 @@ Linux: asciidoctorj-{artifact-version}/bin/asciidoctorj -b pdf -o READTHIS.pdf R
48
49
Windows: asciidoctorj-{artifact-version}\bin\asciidoctorj.bat -b pdf -o READTHIS.pdf README.adoc
49
50
----
50
51
51
-
== Linux and MacOS installation
52
+
== Automated distribution installation
53
+
54
+
=== Linux and MacOS
52
55
53
56
A {url-sdkman}[SDKMAN!] candidate is available for easy installation in Linux and MacOS.
54
57
This will install the binary distribution and set up the PATH automatically.
55
58
56
59
$ sdk install asciidoctorj
57
60
$ asciidoctorj -b pdf README.adoc
58
61
59
-
== Windows installation
62
+
=== Windows
60
63
61
64
A {url-chocolatey}[Chocolatey] package is available which installs the
62
65
asciidoctorj-{artifact-version}-bin.zip Maven artifact along with a
@@ -67,3 +70,19 @@ from the command line.
67
70
C:\> where asciidoctorj
68
71
C:\ProgramData\chocolatey\bin\asciidoctorj.exe
69
72
C:\> asciidoctorj -b pdf README.adoc
73
+
74
+
== Running AsciidoctorJ using JBang
75
+
76
+
{url-jbang}[JBang] enables you to run AsciidoctorJ without needing to install it first. As an added benefit, JBang automatically uses the most recent version of AsciidoctorJ, updating it automatically on subsequent runs.
77
+
78
+
.Linux and MacOS
79
+
[source,shellscript]
80
+
----
81
+
$ jbang run asciidoctorj@asciidoctor -b pdf README.adoc
82
+
----
83
+
84
+
.Windows
85
+
[source,shellscript]
86
+
----
87
+
C:\> jbang run asciidoctorj@asciidoctor -b pdf README.adoc
0 commit comments