A collection of example projects that demonstrates how to use the Asciidoctor Gradle plugin
Java HTML
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
asciidoc-diagram-to-html-example update asciidoctorj to ver.1.5.5 and fix finalizer.gradle. May 29, 2017
asciidoc-to-all-example update versions of gradle and libraries. May 29, 2017
asciidoc-to-deckjs-example update versions of gradle and libraries. May 29, 2017
asciidoc-to-epub3-example update asciidoctorj to ver.1.5.5 and fix finalizer.gradle. May 29, 2017
asciidoc-to-github-pages-example update asciidoctorj to ver.1.5.5 and fix finalizer.gradle. May 29, 2017
asciidoc-to-html-example update asciidoctorj to ver.1.5.5 and fix finalizer.gradle. May 29, 2017
asciidoc-to-html-livereload-example update asciidoctorj to ver.1.5.5 and fix finalizer.gradle. May 29, 2017
asciidoc-to-pdf-example update versions of gradle and libraries. May 29, 2017
asciidoc-to-pdf-with-theme-example update versions of gradle and libraries. May 29, 2017
asciidoc-to-revealjs-example update versions of gradle and libraries. May 29, 2017
gradle/wrapper update versions of gradle and libraries. May 29, 2017
.gitignore Adds *~ to the .gitignore file Apr 3, 2016
.travis.yml Migrate rwinch github id to asciidoctor Mar 30, 2015
LICENSE.adoc Initial Dec 12, 2014
README.adoc Adds DocBook output to the all-example project Apr 3, 2016
build.gradle update versions. May 29, 2017
finalize.gradle update asciidoctorj to ver.1.5.5 and fix finalizer.gradle. May 29, 2017
gradlew add Gradle Versions Plugin and update libraries versions. May 29, 2017
gradlew.bat add Gradle Versions Plugin and update libraries versions. May 29, 2017
settings.gradle Fix settings.gradle Mar 9, 2016

README.adoc

Build Status

Asciidoctor Gradle Plugin: Examples

This repository contains a collection of sample projects that demonstrate numerous ways to use the Asciidoctor Gradle plugin in a Gradle project.

Browsing the examples

You can browse the github pages to view the examples, the code, and sample output at

Getting the examples

Clone the example repository using git:

$ git clone https://github.com/asciidoctor/asciidoctor-gradle-examples

Setting up IntelliJ

If you are using IntelliJ, you can generate the relevant IDE files using:

$ ./gradlew idea

Example catalog

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-pdf-with-theme-example

Demonstrates how to convert AsciiDoc to PDF using Asciidoctor PDF with the Asciidoctor Gradle plugin using a custom theme.

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, DocBook & 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.