Asciidoctor for collaborative book writing

I’ve been searching for the most suitable tools I’d use for my Transaction book writing process and I’ve settled for Asciidoctor.

In the first place, I decided to use a markup text language that’s implicitly supported by GitHub, and after reviewing Markdown and Asciidoc, I opted for the latter for it offers a richer syntax.

The only problem with Asciidoc is Windows. The a2x command uses xmllint, and therefore you must use Cygwin or a virtual machine with a Linux image. This is not what I aim for, and therefore I continued evaluating git-scribe.

This is a tool meant for writing ebooks, and it’s pretty cool unless you use it on Windows. After manually installing all its dependencies (ruby, asciidoc, xsltproc, source-highlight, apache fop), I somehow managed to generate a html book example, but the PDF generation didn’t work. The Apache FOP classes were not found, and since I’m no Ruby expert, I simply gave up and decided to try Asciidoctor.

Running on Ruby, Asciidoctor simply works like a charm. I managed to install a Ruby file watcher that automatically generates the HTML version of my markups. PDF works and the syntax doesn’t scare me a bit. There are small differences between the original AsciiDoc and the new Asciidoctor, but that’s neglectable.

So, my first Asciidoctor document is the README.adoc file associated with the book writing project, and GitHub cleverly previews it as HTML.

If you liked this article, you might want to subscribe to my newsletter too.


Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s