asciidoctor in 15min

15
ASCIIDOCTOR IN 15MIN Schalk W. Cronjé

Upload: schalk-cronje

Post on 31-Jul-2015

189 views

Category:

Software


1 download

TRANSCRIPT

ASCIIDOCTOR IN 15MIN

Schalk W. Cronjé

WHY?

Focus on content, not formatting

Source-control friendly

No proprietary source format

More powerful than Markdown, including

Github MD

Leanpub Markuva

More user friendly than RText or LaTeX

No need to fight Docbook

STATE OF SIMPLE PUBLISING 2014

FLAVOURS

Asciidoctor (Ruby)

Asciidoctorj (JVM)

Asciidoctorjs (Javascript)

Original Asciidoc (Python).

STATE OF ASCIIDOCTOR 2015

DRAWING SUPPORT

PlantUML

Ditaa

Shaape

BlockDiag, SeqDiag, ActDiag, NwDiag

GraphViz DOT

Via asciidoctor-diagram module

DRAWING SUPPORT

+-------------+

| Asciidoctor |-------+

| diagram | |

+-------------+ | PNG out

^ |

| ditaa in |

| v

+--------+ +--------+----+ /---------------\

| | --+ Asciidoctor +--> | |

| Text | +-------------+ | Beautiful |

|Document| | !magic! | | Output |

| {d}| | | | |

+---+----+ +-------------+ \---------------/

SOURCE CODE HIGHLIGHTING[source,cpp]

----

int main(int argc,char** argv) {

std::cout << "Hello, world!" << std::endl;

}

----

int main(int argc,char** argv) {

std::cout << "Hello, world!" << std::endl;

}

MATH EQUATIONSAsciimath

Latexmath

Limitation: Conversion rendered in cloud

BUILDTOOL SUPPORT

Maven

Gradle

Ant

Leiningen

SBT

Grunt

PROJECTS

A number of projects use Asciidoctor for documentationcomplete with tested code snippets, including:

Groovy Language

Spring

Griffon

ACTIVELY IN THE WORKSAsciidoctor → Leanpub

Asciidoctor → Mallard

Asciidoctor → LaTeX

Asciidoctor → Pdf

Asciidoctor → Epub

ABOUT THIS PRESENTATIONWritten in Asciidoctor

Styled by asciidoctor-revealjs extension

Built using:

Gradle

gradle-asciidoctor-plugin

gradle-vfs-plugin

https://bitbucket.org/ysb33r/asciidoctorinanutshell

DEMO

THANK YOUSchalk W. Cronjé

[email protected]

@ysb33r

Read more at http://asciidoctor.org