word lid!
NLJUG logo

Writing documentation with Asciidoctor is awesome

Locatie Track
Vincent Tools
Tijd Moeilijkheidsgraad Taal
16:40:00 - 17:30:00 Beginner Nederlands

To write (technical) documentation usually means we leave our coding environment and for example need to start a word processor or open a wiki where we type in our documentation. Especially when we (must) use word processor software a lot of things will distract us from writing content, we need to worry about formatting, styles, binary content. And when we want to include source code samples we need to copy/paste source code from a environment where it can be executed to static documentation. Asciidoctor is a tool which transforms documents written with Asciidoc, a Markdown-like markup, to HTML, Docbook and PDF. When we use the very simple Asciidoc markup we only focus on content and structure of our documentation. And the really nice feature of Asciidoctor is that we can include the contents of external files, partially or complete, in the generated output. This means our documentation can reference source files that we know is correct, because we have written tests for those source files. More and more frameworks use Asciidoctor for their documentation, like Spring, JBoss, Groovy and Griffon. So learn more about Asciidoctor during this session and write your documentation like the big frameworks do.

Download hier de evaluatie van deze sessie

Bio van Hubert Klein Ikkink

Hubert Klein Ikkink is also known as mrhaki. He uses his alias to write on my blog “Messages from mrhaki”. On this blog he writes short tips and tricks about Groovy features in the “Groovy Goodness” series. Hubert started to develop Java applications more than a decade ago. Five years ago he started to explore Groovy and Grails in personal projects, because of the dynamic nature of Groovy and the speed of development. Today he works with Groovy and Grails during his daytime job at JDriven in the Netherlands. In 2012 Hubert wrote the book Gradle Effective Implementation Guide for Packt Publishing. The book is a great introduction and reference for using Gradle. The Gradle build language is explained with hands on code and practical applications. You learn how to apply Gradle in your Java, Scala or Groovy projects, integrate with your favorite IDE and how to integrate with well-known continuous integration servers. In 2015 he wrote the book Gradle Dependency Management released by Packt Publishing.