Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.53 KB

README.adoc

File metadata and controls

62 lines (40 loc) · 1.53 KB

SBuild Asciidoctor Plugin

This SBuild plugin integrates Asciidoctor into SBuild.

Download

SBuild Asciidoctor Plugin can be downloaded from Maven Central.

To include it in you SBuild buildfile use the @classpath annotation:

@classpath("mvn:org.sbuild:org.sbuild.plugins.asciidoctor:0.1.0")

Building from Source

You need a recent version of SBuild.

git clone https://github.com/SBuild-org/asciidoctor.git
cd sbuild-sbuild-plugin/org.sbuild.plugins.asciidoctor
sbuild all

You will find the built jar in the directory org.sbuild.plugins.asciidoctor/target.

Requirements

This plugin requires at least SBuild 0.7.1.

Configuration

All configurable properties are documented via ScalaDoc. See file Asciidoctor.scala.

Examples

Minimal example, which will generate a jbake site from src/asciidoc to target/asciidoc.

import de.tototec.sbuild._

@version("0.7.1")
@classpath("mvn:org.sbuild:org.sbuild.plugins.asciidoctor:0.1.0")
class SBuild(implicit _project: Project) {

  import org.sbuild.plugins.asciidoctor._
  Plugin[Asciidoctor]

}

Changelog

SBuild Asciidoctor Plugin 0.1.0 - 2014-01-30

  • Initial Release