This documentation covers a prerelease version of the software. Follow this link to view the documentation for the stable version (4.0) instead.

Asciidoctor Gradle Plugin Suite

The Asciidoctor Gradle Plugin Suite is the official means of using Asciidoctor to convert all your AsciiDoc documentation using Gradle.

This started as a port of the asciidoctor-maven-plugin project founded by Jason Porter and relies on AsciidoctorJ which was founded by Alex Soto. In fact the 1.5.x series of the Asciidoctor Gradle plugin can still be considered a port.

However, with the 2.x series came a complete departure with functionality far exceeding any lightweight markup plugins for any other build tool. With the 3.x serious allows for even more flexibility and options for the creation of a true DocuOps pipeline by bringing together Gradle as a powerful and generic build tool, and Asciidoctor as an agile and lightweight document generator. With 4.x came Gradle 8.x compatibility, and there was an attempt to make it configuration-cache compliant.

Now with 5.x comes a new model, which simplifies declaration and removes the need to configure tasks. Although it still has the classic usage available that was in 4.x, and which is not configuration-cache-compatible, the new model in 5.x offers both Gradle 9.x compatibility and configuration cache-compatibility.

Requirements

Engine Minimum Gradle Minimum JDK

asciidoctorj

8.0.2

11

asciidoctor.js

8.0.2

8