Asciidoctor quickie Devoxx 2013

1. Asciidoctor,
because documentation
does not have to suck
Andres Almiray
andres.almiray@canoo.com
@aalmiray

5. TOOLS

7. = Hello, Devoxx!
Doc Writer <doc@example.com>
An introduction to http://asciidoc.org[AsciiDoc].
== First Section
* item 1
* item 2
[source,ruby]
puts "Hello, World!"

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

10. 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

11. asciidoctor {
backends = [‘html5’, ‘docbook’]
options = [
toc: ‘left’,
‘toc-title’: ‘Table of Contents’,
‘projectVersion’: project.version
]
}

12. /**
* = 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() { … }
}

13. Seeing is believing
Any .adoc gist can be pointed at
http://docgist.narowth.se
and gets automatically rendered to HTML

14. 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