Search⌘ K

Asciidoctor Setup

Explore how to use Asciidoctor as a text processor to convert AsciiDoc snippets into HTML5 documentation. Understand the setup process including integrating the Asciidoctor plugin into Gradle, configuring it to locate REST Docs snippets, and generating API documentation files effectively.

We'll cover the following...

We need a text processor to convert AsciiDoc snippets into HTML5-based API documentation. So, we can use Asciidoctor, which provides an ecosystem to work with Java, Spring, and Gradle projects. Asciidoctor is relatively easy to set up.

Asciidoctor setup

Let’s add ...