search

asciidoctor / asciidoctorj

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

Any redistributed package? #583

Open hcoona opened 6 years ago

hcoona commented 6 years ago

Because I found there is org.asciidoctor.cli.AsciidoctorInvoker, do we have any redistributed package for the guys who don't want install ruby version with whole ruby system?

robertpanzer commented 6 years ago

Hi!

When using AsciidoctorJ there is no need at all to install Ruby at the same time. AsciidoctorJ contains Asciidoctor and bundles JRuby in it. There are several ways to install AsciidoctorJ. If you already use SDKMAN, then it should be as simple as sdk install asciidoctorj.

Otherwise you can download a binary distribution for example at Bintray. The Files section contains a -bin.zip archive.

hcoona commented 6 years ago

Exactly what I means. I suggest publish this bundled binary distribution on asciidoctor official site as an alternative to gem installing. This would be nice for the people who is not a developer nor have Ruby environment.

hcoona commented 6 years ago
  1. Most users didn't have Ruby environment
  2. But many users have Java runtime
  3. We provided installation steps on asciidoctor portal for the gem one instead of the java one
  4. This would prevent many people from using asciidoctor for who didn't want install whole Ruby environment

So I suggest publish this Java bundle to our portal as well.

robertpanzer commented 6 years ago

Hi,

maybe I expressed myself badly, but there is no need at all to install Ruby or handle with Gems if you don't want to.

If you have Java and also SDKMAN installed (see link above), then simply calling sdk install asciidoctorj will give you Asciidoctor on the path that you can invoke on the command prompt via asciidoctorj.

If you don't have SDKMAN and don't want it, the you can download the zip from the Bintray archive, unpack it, and run the bin/asciidoctorj from there.

abelsromero commented 6 years ago

Hi,

I think the issue that @hcoona reports is about awareness. Currently, the site documentation (http://asciidoctor.org/docs/install-toolchain/) does not describe the process to install AsciidoctorJ (or JavaScript), but only describes the Ruby implementation. That makes entry for Java users a bit harder, because unless they found about AsciidoctorJ on their own they will try to install a Ruby environment.

Is that so?

hcoona commented 6 years ago

Yes, @abelsromero you get the point.

@robertpanzer you well explained about the asciidoctorj, but we are talking 2 stories. It's my bad to mix them together because I have to confirm whether asciidoctorj could run as a CLI tools before the awareness problem. I jumps to fast.

The site document only mentioned about the ruby version, which is very unfriendly to new users who didn't have ruby environment. AsciidoctorJ made a great progress to get rid of full ruby environment nor nodejs environment. I think it necessary to provided a well bundled version of AsciidoctorJ & publish it to the site document.

abelsromero commented 6 years ago

In that case we should move this issue to https://github.com/asciidoctor/asciidoctor.org. Reviewing the site (http://asciidoctor.org/docs/), in the same page, below, there's a section about other ways to use Asciidoctor (AsciidoctorJ, maven, gradle, JS, etc.), but it's quite outdated, does not adress he CLI and does not address the of "being nice and easy for Java people". And agree we should at least discuss how to address this point.

mojavelinux commented 6 years ago

I agreed. We should definitely add this information to asciidoctor.org. We know we want to rework the site to make it more up to date, but that shouldn't stop us from fixing this specific page now.

I'll also add it to my list to turn the asciidoctorj page into an include like the reveal.js page so that is in sync with the README from the repo. I just need to make sure we don't lose any edits...though that won't take me long.

geraldcombs commented 6 years ago

If it's of any use you can now install AsciidoctorJ using Chocolatey (#582) and you should hopefully be able to install it using Homebrew soon (Homebrew/homebrew-core#19517). Both download and unpack the -bin.zip from Bintray and add a shim or link to the asciidoctorj command.

mojavelinux commented 6 years ago

The website now uses the README from the master branch. In the future we'll probably switch to a tag, but I need some changes that are in the master branch in order for it to work.

@robertpanzer I know we probably want to show the docs for AsciidoctorJ 1.6.0, but I'm going to defer that until we overhaul the website...which we're going to get started on later this quarter. The new website will let you browse different versions of the page.