asciidoctor / asciidoctorj

:coffee: Java bindings for Asciidoctor. Asciidoctor on the JVM!
http://asciidoctor.org
Apache License 2.0
625 stars 173 forks source link

Document how to setup and use the AsciidoctorJ distribution #261

Open mojavelinux opened 9 years ago

mojavelinux commented 9 years ago

Document in the AsciidoctorJ manual (i.e., the README) how to setup and use the AsciidoctorJ distribution. This is by far the easiest way to get Asciidoctor (via AsciidoctorJ) setup for end users.

We should recommend using gvm to install AsciidoctorJ.

$ curl -s get.gvmtool.net -o gvm-setup.sh && bash gvm-setup.sh

After reloading the terminal, gvm can be used to install the AsciidoctorJ distribution:

$ gvm install asciidoctorj

This will make the asciidoctorj command available, which is a drop-in replacement for the asciidoctor command:

$ asciidoctorj -V

The command provides support for the following backends out of the box:

For example, you can convert a document to PDF using:

$ asciidoctorj -b pdf sample.adoc
msgilligan commented 6 years ago

This is a great way to get started with AsciidoctorJ. Although it's now:

 $ sdk install asciidoctorj