Migrate docs to Antora site

asciidoctor / asciidoclet

:clipboard: A Javadoc Doclet based on Asciidoctor that lets you write Javadoc in the AsciiDoc syntax.

https://github.com/asciidoctor/asciidoclet

Apache License 2.0

132 stars 40 forks source link

Migrate docs to Antora site #103

Closed abelsromero closed 3 years ago

abelsromero commented 3 years ago

Migrates the README and src/docs/asciidoc/asciidoclet-powered.adoc to an Antora structure under docs directory.

NOTE: Kept the doc release-process.adoc out of the site because is not complete and I am not sure it fits.

I kept the same structure except for:

Renamed Introduction section to Getting Started. This page contains the examples so to me it makes sense.
Converted Log Warning below Usage section into a Warning admonition inside Usage

abelsromero commented 3 years ago

I tested the generated target/apidocs/overview-summary.html file with the new overview.adoc and I could generate the same as now using an include with as exclusion :v:

abelsromero commented 3 years ago

Ready for review. This is the toc

abelsromero commented 3 years ago

Fixed the references to options in Usage.adoc so they work both in the HTML for the doctlet and Antora.

With that, no more changes from my site :+1:

mojavelinux commented 3 years ago

The docs.asciidoctor.org site is about to go live and I'd love to see the Asciidoclet documentation there when we launch. We even have a space reserved for it in the navbar. @johncarl81 or @msgilligan, could you have a look and approve if you're on board?

johncarl81 commented 3 years ago

Looks good to me!