madmas / AsciidoctorGradle-Doc2Life

Living Documentation with Asciidoctor & Gradle - Slides & Examples

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

Living Documentation with Asciidoctor & Gradle - Slides & Examples