Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document command line in readme.adoc #567

Open
rockyallen opened this issue Aug 4, 2017 · 6 comments
Open

Document command line in readme.adoc #567

rockyallen opened this issue Aug 4, 2017 · 6 comments

Comments

@rockyallen
Copy link

I came across #360 while searching for a way to run asciidoc-bibtex AND a Java extension at the same time.
First, can asciidoctorj do this, and what command line would I need?
Second, should the command line be documented in readme.adoc?

@mojavelinux
Copy link
Member

The asciidoctorj command works exactly the same way as the asciidoctor command. The only difference is that the command ends in a "j".

That's not strictly true, because technically AsciidoctorJ reimplements the cli. However, I still feel strongly that AsciidoctorJ should be delegating to the Asciidoctor cli so it really is the same. See #193.

@rockyallen
Copy link
Author

rockyallen commented Aug 5, 2017

Thanks. Just re-read the readme, and it makes more sense now.
What I want can't be done from the CLI, but I can write my own program against the AsciidoctorJ API, use the SPI interface for the Java extensions, and the require mechanism for asciidoctor-bibtex.
I think.
Still worth a mention in the readme that there is a CLI-it currently only discusses the API.

@mojavelinux
Copy link
Member

mojavelinux commented Aug 6, 2017 via email

@msgilligan
Copy link
Member

Are there instructions for how to render PlantUML with asciidoctorj command-line?

@robertpanzer
Copy link
Member

It should be similar to the corresponding asciidoctor command:

$ asciidoctorj -r asciidoctor-diagram ...

@msgilligan
Copy link
Member

Thanks, @robertpanzer , that command should probably be in the README -- that's really useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants