asciidoctor-gradle-examples 0

A collection of example projects that demonstrates how to use the Asciidoctor Gradle plugin

image::https://travis-ci.org/asciidoctor/asciidoctor-gradle-examples.svg?branch=master[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

http://asciidoctor.github.io/asciidoctor-gradle-examples/

== 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.

link:asciidoc-to-html-example/README.adocasciidoc-to-html-example:: Demonstrates how to convert AsciiDoc to HTML5 using the Asciidoctor Gradle plugin.

link:asciidoc-to-html-livereload-example/README.adoc[asciidoc-to-html-livereload-example] :: Demonstrates how to convert AsciiDoc to HTML5 using the Asciidoctor Gradle plugin with http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/#livereload[Live Reload] support.

link:asciidoc-diagram-to-html-example/README.adoc[asciidoc-diagram-to-html-example] :: Demonstrates how to convert AsciiDoc http://asciidoctor.org/docs/asciidoctor-diagram/[diagrams] to HTML5 using the Asciidoctor Gradle plugin.

link:asciidoc-to-pdf-example/README.adoc[asciidoc-to-pdf-example]:: Demonstrates how to convert AsciiDoc to PDF using Asciidoctor PDF with the Asciidoctor Gradle plugin.

link:asciidoc-to-pdf-with-theme-example/README.adoc[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.

link:asciidoc-to-epub3-example/README.adoc[asciidoc-to-epub3-example]:: Demonstrates how to convert AsciiDoc to epub3 using Asciidoctor epub3 with the Asciidoctor Gradle plugin.

link:asciidoc-to-deckjs-example/README.adoc[asciidoc-to-deckjs-example]:: Demonstrates how to convert AsciiDoc to deck.js using Asciidoctor deckjs with the Asciidoctor Gradle plugin.

link:asciidoc-to-revealjs-example/README.adoc[asciidoc-to-revealjs-example]:: Demonstrates how to convert AsciiDoc to reveal.js using Asciidoctor revealjs with the Asciidoctor Gradle plugin.

link:asciidoc-to-all-example/README.adoc[asciidoc-to-all-example]:: Demonstrates how to convert AsciiDoc to HTML5, PDF, DocBook & epub3 using Asciidoctor extensions with the Asciidoctor Gradle plugin.

== Copyright and Licensing

Copyright © 2014 The Asciidoctor Project. Free use of this software is granted under the terms of the MIT License.

See the link:LICENSE.adoc[] file for details.

Related Repositories

asciidoctor-gradle-examples

asciidoctor-gradle-examples

A collection of example projects that demonstrates how to use the Asciidoctor Gradle plugin ...

asciidoctor-gradle-examples

asciidoctor-gradle-examples

A collection of example projects that demonstrates how to use the Asciidoctor Gradle plugin http://asciidoctor.org/docs/asciidoctor-gradle-plugin ...

asciidoctor-gradle-examples

asciidoctor-gradle-examples

A collection of example projects that demonstrates how to use the Asciidoctor Gradle plugin ...

asciidoctor-gradle-examples

asciidoctor-gradle-examples

A collection of example projects that demonstrates how to use the Asciidoctor Gradle plugin ...

asciidoctor-gradle-examples

asciidoctor-gradle-examples

A collection of example projects that demonstrates how to use the Asciidoctor Gradle plugin http://asciidoctor.org/docs/asciidoctor-gradle-plugin ...


Top Contributors

rwinch danhyun craigburke mojavelinux ysb33r nobusugi246 vogella schauder fwilhe alkemist kubamarchwicki