Slide 1

Slide 1 text

Asciidoctor: Because writing documentation does not have to suck Andres Almiray @aalmiray [email protected]

Slide 2

Slide 2 text

Java developer since the beginning True believer in Open Source Groovy committer since 2007 Project lead of the Griffon framework Currently working for About the Speaker

Slide 3

Slide 3 text

About the Speaker

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

About the Speaker

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

= Hello, Gr8conf! Doc Writer An introduction to http://asciidoc.org[AsciiDoc]. == First Section * item 1 * item 2 [source,groovy] ---- println "Hello, World!" ----

Slide 8

Slide 8 text

No content

Slide 9

Slide 9 text

The Asciidoctor Bunch @alexsotob! @lightguardjp! @mojavelinux! @carbonfray!

Slide 10

Slide 10 text

http://asciidoctor.org •  Gradle! •  Maven! •  Plain Java! •  Javascript (asciidoctor.js)! •  Chrome extension! •  Firefox addon! •  http://github.com/asciidoctor!

Slide 11

Slide 11 text

build.gradle buildscript {! repositories {! maven {! url 'http://dl.bintray.com/content/aalmiray/asciidoctor’! }! jcenter()! }! ! dependencies {! classpath 'org.asciidoctor:asciidoctor-gradle-plugin:0.7.0’! }! }! ! apply plugin: 'asciidoctor! !

Slide 12

Slide 12 text

Configuration asciidoctor {! backends = [‘html5’, ‘docbook’] // more to come!! options = [! toc: ‘left’,! ‘toc-title’: ‘Table of Contents’,! ‘projectVersion’: project.version! ]! }! !

Slide 13

Slide 13 text

Asciidoclet /**! * = Asciidoclet! *! * Sample comments that include +source code+.! *! * [source,java]! * --! * public class Main{! * public static void main(String[] args) {! * Foo.doAwesomeStuff();! * }! * }! * --! *! * @author https://github.com/asciidoctor[asciidoctor]! */! public class Foo {! public static void doAwesomeStuff() { … }! }!

Slide 14

Slide 14 text

Want more examples? Groovy, Golo and Ceylon languages use Asciidoc for their documentation The Spring framework manual Asciidoctor website itself Arquillian, Weld and other JBoss sites The animals-on-covers book publisher accepts Asciidoc as a format J

Slide 15

Slide 15 text

STOP!! ! DEMO TIME!

Slide 16

Slide 16 text

Q & A!

Slide 17

Slide 17 text

THANK YOU!! ! @aalmiray! [email protected]!