Asciidoctor, because documentation does not have to suck

2,742 views

Published on

Asciidoctor quickie Devoxx 2013

Published in: Technology
1 Comment
7 Likes
Statistics
Notes
No Downloads
Views
Total views
2,742
On SlideShare
0
From Embeds
0
Number of Embeds
22
Actions
Shares
0
Downloads
10
Comments
1
Likes
7
Embeds 0
No embeds

No notes for slide

Asciidoctor, because documentation does not have to suck

  1. 1. Asciidoctor, because documentation does not have to suck Andres Almiray andres.almiray@canoo.com @aalmiray
  2. 2. TOOLS
  3. 3. = 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!"
  4. 4. http://github.com/asciidoctor Gradle Maven Plain Java Javascript (asciidoctor.js) Chrome extension Firefox addon
  5. 5. 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
  6. 6. asciidoctor { backends = [‘html5’, ‘docbook’] options = [ toc: ‘left’, ‘toc-title’: ‘Table of Contents’, ‘projectVersion’: project.version ] }
  7. 7. /** * = 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() { … } }
  8. 8. Seeing is believing Any .adoc gist can be pointed at http://docgist.narowth.se and gets automatically rendered to HTML
  9. 9. 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

×