rwinch / 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 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.

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 and Licensing

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.

asciidoctor-gradle-examples's Issues

epub3 output does not render correctly

Add CI Build to deploy samples to gh-pages

Related #6

Add gh-pages to show demo of various outputs

Use github fork badge?

What do you think about using a fork badge inplace of the link we have in the gh-pages index page.

I have a preview here http://danhyun.github.io/asciidoctor-gradle-examples/

It's currently "fixed" but could set as "absolute" if you want.