This repository contains a collection of sample projects that demonstrate numerous ways to use the Asciidoctor Gradle plugin in a Gradle project.
You can browse the github pages to view the examples, the code, and sample output at
Clone the example repository using git:
$ git clone https://github.com/asciidoctor/asciidoctor-gradle-examples
If you are using IntelliJ, you can generate the relevant IDE files using:
$ ./gradlew idea
You can optionally run all of examples at once using the following command from the repository root:
$ ./gradlew asciidoctor
Alternatively, you can treat each project as a distinct module. Refer to the README file in each individual project to learn how to run it.
- asciidoc-to-html-example (aka “The Quickstart”)
-
Demonstrates how to convert AsciiDoc to HTML5 using the Asciidoctor Gradle plugin.
- asciidoc-to-html-livereload-example
-
Demonstrates how to convert AsciiDoc to HTML5 using the Asciidoctor Gradle plugin with Live Reload support.
- asciidoc-diagram-to-html-example
-
Demonstrates how to convert AsciiDoc diagrams to HTML5 using the Asciidoctor Gradle plugin.
- asciidoc-to-pdf-example
-
Demonstrates how to convert AsciiDoc to PDF using Asciidoctor PDF with the Asciidoctor Gradle plugin.
- asciidoc-to-epub3-example
-
Demonstrates how to convert AsciiDoc to epub3 using Asciidoctor epub3 with the Asciidoctor Gradle plugin.
- asciidoc-to-deckjs-example
-
Demonstrates how to convert AsciiDoc to deck.js using Asciidoctor deckjs with the Asciidoctor Gradle plugin.
- asciidoc-to-revealjs-example
-
Demonstrates how to convert AsciiDoc to reveal.js using Asciidoctor revealjs with the Asciidoctor Gradle plugin.
- asciidoc-to-all-example
-
Demonstrates how to convert AsciiDoc to HTML5, PDF, & epub3 using Asciidoctor extensions with the Asciidoctor Gradle plugin.
Copyright © 2014 The Asciidoctor Project. Free use of this software is granted under the terms of the MIT License.
See the LICENSE.adoc file for details.