J-Fall 2022: Hubert Klein Ikkink – Spice Up Asciidoctor Documentation With Java

Writing documentation is important, but often still an afterthought in projects. What if we could write documentation like we write our code? Asciidoctor is one of the solutions to fulfill this promise. We can use a markup language to write out documentation, keep it close to our source code and even reference that source code in our documentation. Although Asciidoctor already provides a lot out of the box we can extend Asciidoctor as well through extensions. And for Java developers the good news is that we can write those extensions also in Java. Asciidoctor has several extension points where we can use our own custom extension in Java. For example if we want to include example code written in different languages in our documentation we can support this with an extension. Or if we want to reference external links like tasks, issues with a concise syntax. During the session we will see through live-coding which extension points Asciidoctor provides and how we can write those extensions using Java.