LiveReload + Asciidoctor + Gradle

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

LiveReload + Asciidoctor + Gradle

aalmiray
Hello fellow doc writers,

There's a new gradle plugin that may come in handy when working with Asciidoctor: https://github.com/aalmiray/livereload-gradle-plugin

It basically wraps livereload-jvm with a tiny gradle task. It's said that good things come in small packages, and that's true for this particular plugin, as it's aware of the existence of the asciidoctor plugin. The livereload plugin will automatically pick up the outputDir of the asciidoctor task as the docRoot to use. This works only for the default AsciidoctorTask added by the asciidoctor plugin itself; any custom AsciidoctorTask will be ignored. so basically, if you're using asciidoctor + livereload with default settings you can immediately get down to business with no extra config.

And don't worry about livereload and asciidoctor having a tight integration, you may use livereload with other plugins without having to install asciidoctor (but why wouldn't you, amiright? ;-) In the future this plugin may support jbake and other rendering plugins.

Feedback is always welcome.

Cheers,
Andres
Reply | Threaded
Open this post in threaded view
|

Re: LiveReload + Asciidoctor + Gradle

mojavelinux
Administrator

Andres,

Another welcomed surprise! Thanks for putting this together, Andres! I look forward to giving it a spin.

This reminds me that our "editing with live preview" page in the docs could definitely use some updates. If you, or anyone using this plugin, wants to carve out a brief section to cover the use of Gradle LiveReload, it's a surefire way to get a bunch of users / testers, not to mention happy writers.

Cheers,

-Dan

On Feb 21, 2014 2:06 PM, "aalmiray [via Asciidoctor :: Discussion]" <[hidden email]> wrote:
Hello fellow doc writers,

There's a new gradle plugin that may come in handy when working with Asciidoctor: https://github.com/aalmiray/livereload-gradle-plugin

It basically wraps livereload-jvm with a tiny gradle task. It's said that good things come in small packages, and that's true for this particular plugin, as it's aware of the existence of the asciidoctor plugin. The livereload plugin will automatically pick up the outputDir of the asciidoctor task as the docRoot to use. This works only for the default AsciidoctorTask added by the asciidoctor plugin itself; any custom AsciidoctorTask will be ignored. so basically, if you're using asciidoctor + livereload with default settings you can immediately get down to business with no extra config.

And don't worry about livereload and asciidoctor having a tight integration, you may use livereload with other plugins without having to install asciidoctor (but why wouldn't you, amiright? ;-) In the future this plugin may support jbake and other rendering plugins.

Feedback is always welcome.

Cheers,
Andres


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/LiveReload-Asciidoctor-Gradle-tp1528.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML