Andres Almiray on Ascii Doctor

Transcript

1. Asciidoctor: Because writing documentation does not have to suck Andres Almiray @aalmiray andres.almiray@canoo.com
2. 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
3. About the Speaker
5. About the Speaker
7. = Hello, Gr8conf! Doc Writer <doc@example.com> An introduction to http://asciidoc.org[AsciiDoc]. == First Section * item 1 * item 2 [source,groovy] ---- println "Hello, World!" ----
9. The Asciidoctor Bunch @alexsotob! @lightguardjp! @mojavelinux! @carbonfray!
10. http://asciidoctor.org •  Gradle! •  Maven! •  Plain Java! •  Javascript (asciidoctor.js)! •  Chrome extension! •  Firefox addon! •  http://github.com/asciidoctor!
11. 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! !
12. Configuration asciidoctor {! backends = [‘html5’, ‘docbook’] // more to come!! options = [! toc: ‘left’,! ‘toc-title’: ‘Table of Contents’,! ‘projectVersion’: project.version! ]! }! !
13. 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() { … }! }!
14. 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
15. STOP!! ! DEMO TIME!
16. Q & A!
17. THANK YOU!! ! @aalmiray! andres.almiray@canoo.com!