/asciidoctor-gradle-plugin

A Gradle plugin that uses Asciidoctor via JRuby to process AsciiDoc source files within the project.

Primary LanguageRubyApache License 2.0Apache-2.0

Asciidoctor Gradle Plugin

Travis Build Status

This is a port of the asciidoctor-maven-plugin project by @LightGuard.

Installation

Use the following snippet

buildscript {
    repositories {
        mavenRepo name: 'Bintray', url: 'http://dl.bintray.com/content/aalmiray/asciidoctor'
        mavenCentral()
    }
    dependencies {
        classpath 'org.asciidoctor:asciidoctor-gradle-plugin:0.2'
    }
}
apply plugin: 'asciidoctor'

Usage

The plugin adds a new task named asciidoctor. This task exposes two properties as part of its configuration

  • sourceDir - where the asciidoc sources are. Type: File. Default: src/asciidoc.
  • outputDir - where generated docs go. Type: File. Default: $buildDir/asciidoc.
  • backend - the backend to use Default: html5.

Sources may have any of the following extensions in order to be discovered

  • .asciidoc
  • .adoc
  • .asc
  • .ad

History

0.2

  • Support Asciidoctor 0.1.1
  • Backends: html5, docbook

0.1

  • First release.
  • Supports Asciidoctor 0.0.9
  • Backends: html5