Re: asciidoctor-j based documentation generator
Posted by
mojavelinux on
May 05, 2019; 9:55am
URL: https://discuss.asciidoctor.org/asciidoctor-j-based-documentation-generator-tp6888p6895.html
Technically, Antora doesn't use anything. It's up to you what you want to use. Algolia docsearch happens to work well because you simply point it at a site and it gives you an index that you can query via JavaScript.
For more details of this discussion, see:
> Antora runs on JS, so there's no Java alternative.
While that's true, it's possible to run JavaScript / Node applications via Gradle. Schalk has been working on Asciidoctor.js integration in the Asciidoctor Gradle plugin, and I suspect that Antora integration isn't that far off.
Best,
-Dan
On Sun, May 5, 2019 at 3:37 AM abelsromero [via Asciidoctor :: Discussion] <
[hidden email]> wrote:
PzdcDoc wrote
Yes, Antora seems to be quite similar. Didn't notice it before. I will have a closer look.
And there is embedded search already at
docs.antora.org, isn't it available out of box?
Antora uses angolia (https://www.algolia.com/) for the content indexation and search box in the docs site.
Afaik it offers some free options for open source projects. Other than that I googled some time ago and found some JS libs but I am not sure how good they are.
PzdcDoc wrote
Java is preferable way for me, bacause of using it in most of projects..
So ideally it has to be one artifact in Maven Central with main class.
I know, what NodeJS is nearly the same, it is only question of already using stack and getting new dependencies.
Antora runs on JS, so there's no Java alternative. However, don't be afraid, I come from the same place and I can assure there's nothing to worry. All the team at the office is happy with it and we are all Java devs.
To simplify installation, just use docker if you don't want to "pollute" your machine with npm home directory https://docs.antora.org/antora/2.0/antora-container/. If you're prefer to install antora on bare metal, just use "nvm", it's available for Windows and Linux. https://docs.antora.org/antora/2.0/install/linux-requirements/
If it helps, on Windows I use the Linux tools in a WSL machine.
--