madmas / asciidoctorgradle-doc2life

Living Documentation with Asciidoctor & Gradle - Slides & Examples

Living documentation with Asciidoctor and Gradle

Presentation

Please find the presentation slides at presentation/Slides_DevoxxMA2017.pdf

Examples

The examples are accessible via the branches within this repository:

branch name	description
master	first example, showing the basic gradle build generating HTML and PDF from src/doc/main.adoc, demonstrating AsciiDoctor syntax and base features
includeByLine	demonstrate including a code snippet via reference by line numbers
includeByLabel	demonstrate including a code snippet via reference by tag
variables	demonstrate passing the version number from the build into the generated document
livingDoc	demonstrate using a CSV a source for data driven tests and the generated documentation at the same time

Resources

Some interesting links:

asciidoctor-gradle-examples

Discover the zen of writing AsciiDoc

AsciiDoc with pleasure

When WebSockets meet AsciiDoctor

Asciidoctor Tips from Devoxx 2014

MrHaki’s Blog with regular posts on AsciiDoctor

Peter Ledbrook: 'Practical Groovy'

Slides with AsciiDoctor & Gradle by Cédric Champeau

Devoxx 2017

Hubert Sablonnière: Documentation as Code (explained to my dad)

Asciidoctor: New, Noteworthy, and Beyond by Alex Soto