15
#DevoxxFR Comment Asciidoctor peut vous aider pour votre doc [email protected] 1

Comment Asciidoctor peut vous aider pour votre doc

Embed Size (px)

Citation preview

Page 1: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Comment Asciidoctor peut vous

aider pour votre doc

[email protected]

1

Page 2: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Bio Software developer

@j2r2b

+JeremieBresson

jmini

Occasional open-source contributor:

• Eclipse Scout

• Asciidoctor

• Mylyn Wikitext

• …

2

Page 3: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR 3

BSI AG

Baar Baden Bern Düsseldorf

Frankfurt Munich Zurich

Page 4: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR 4

BSI CRM

Page 5: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR 5

Eclipse Scout

@Order(1000)

public class FirstNameField extends AbstractStringField {

@Override

protected String getConfiguredLabel() {

return TEXTS.get("FirstName");

}

}

www.eclipse.org/scout

Page 6: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Asciidoctor

6

Asciidoctor is a publishing toolchain for the AsciiDoc writing format.

Written in Ruby (and transpiled to JavaScript) (can be used with JRuby in the JVM)

Open Source (MIT Licence)

Page 7: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

AsciiDoc example

7

= Getting Started with Java Author Name <[email protected]> == Hello World example Copy the *HelloWorld.java* file. TIP: The application prints _Hello World!_ to the console. * Compile this source to a class file using `javac`. * Run the compiled class file using `java`. If you need help with the Java syntax check the link:http://docs.oracle.com/javase/8/docs/[Java 8 Javadoc].

Page 8: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Headings

8

= Getting Started with Java Author Name <[email protected]> == Hello World example Copy the *HelloWorld.java* file. TIP: The application prints _Hello World!_ to the console. * Compile this source to a class file using `javac`. * Run the compiled class file using `java`. If you need help with the Java syntax check the link:http://docs.oracle.com/javase/8/docs/[Java 8 Javadoc].

Document Title

hackers

Section Level 1

Page 9: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Lists

9

= Getting Started with Java Author Name <[email protected]> == Hello World example Copy the *HelloWorld.java* file. TIP: The application prints _Hello World!_ to the console. * Compile this source to a class file using `javac`. * Run the compiled class file using `java`. If you need help with the Java syntax check the link:http://docs.oracle.com/javase/8/docs/[Java 8 Javadoc].

Unorder list items

Page 10: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Inline formatting

10

= Getting Started with Java Author Name <[email protected]> == Hello World example Copy the *HelloWorld.java* file. TIP: The application prints _Hello World!_ to the console. * Compile this source to a class file using `javac`. * Run the compiled class file using `java`. If you need help with the Java syntax check the link:http://docs.oracle.com/javase/8/docs/[Java 8 Javadoc].

bold

italic

code

Page 11: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Links

11

= Getting Started with Java Author Name <[email protected]> == Hello World example Copy the *HelloWorld.java* file. TIP: The application prints _Hello World!_ to the console. * Compile this source to a class file using `javac`. * Run the compiled class file using `java`. If you need help with the Java syntax check the link:http://docs.oracle.com/javase/8/docs/[Java 8 Javadoc].

Link with title

Page 12: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Admonition

12

= Getting Started with Java Author Name <[email protected]> == Hello World example Copy the *HelloWorld.java* file. TIP: The application prints _Hello World!_ to the console. * Compile this source to a class file using `javac`. * Run the compiled class file using `java`. If you need help with the Java syntax check the link:http://docs.oracle.com/javase/8/docs/[Java 8 Javadoc].

Page 13: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

AsciiDoc example

13

= Getting Started with Java Author Name <[email protected]> == Hello World example Copy the *HelloWorld.java* file. TIP: The application prints _Hello World!_ to the console. * Compile this source to a class file using `javac`. * Run the compiled class file using `java`. If you need help with the Java syntax check the link:http://docs.oracle.com/javase/8/docs/[Java 8 Javadoc].

Page 14: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Pour se lancer

14

Débuter avec Asciidoctor (article en français) http://asciidoctor.org/news/2016/04/05/debuter-avec-asciidoctor/

Les Cast Codeurs Podcast – Episode 144 https://lescastcodeurs.com/2016/04/05/lcc-144-interview-asciidoctor-avec-maxime-greau-et-guillaume-scheibel/

Page 15: Comment Asciidoctor peut vous aider pour votre doc

#DevoxxFR

Thanks

@j2r2b

+JeremieBresson

jmini

[email protected]

15