Document how to run AsciidoctorJ using JBang #1315
Conversation
docs/modules/ROOT/pages/cli.adoc
Outdated
| ---- | ||
|
|
||
| == Linux and MacOS installation | ||
| == Automatic distribution installation |
There was a problem hiding this comment.
I am a bit unsure about the term "Automatic distribution installation".
What exactly does that mean?
There was a problem hiding this comment.
I used the orginal starting text as reference which talks about "automatic installation".
There are two basic ways to make AsciidoctorJ available as a command line tool.
* Manual installation using the binary distribution.
* Automatic installation using a package manager like SDKMAN or Chocolatey.
Most likely the word the writer had in mind was Automated instead of Automatic.
Automated distribution installation
There was a problem hiding this comment.
Oh, I wonder if I wrote this :D
Yes, I think automated sounds better.
There was a problem hiding this comment.
@robertpanzer , will this update appear at https://docs.asciidoctor.org/asciidoctorj/latest/cli/ automatically or will the docs site only be updated when a future release of asciidoctorj becomes available? Was hoping to see the update appear sooner rather than later.
There was a problem hiding this comment.
The docs pull from the main branch (see https://github.com/asciidoctor/docs.asciidoctor.org/blob/main/antora-playbook.yml#L39-L41), so the update will be seen after the nightly run. I can go ahead and trigger it now.
3 participants
Thank you for opening a pull request and contributing to AsciidoctorJ!
Please take a bit of time giving some details about your pull request:
Kind of change
Description
AsciidoctorJ can be run directly from the command-line using JBang without having first having to install AsciidoctorJ. Update the cli.adoc file to describe how to use AsciidoctorJ with JBang.
Issue
If this PR fixes an open issue, please add a line of the form:
Fixes #1314
Release notes
Please add a corresponding entry to the file CHANGELOG.adoc