README DOCUMENT

Sommaire

• 1. introduction
• 2. solution

1. introduction

I’m currently moving to asciidoc and plantuml to write docs. Github asciidoc parsing does not understand plantuml.

⚠️	AsciiDoc on GitHub currently needs some tricks. See GitHub Flavored Asciidoc (GFA) for Tips.

2. solution

Use plantuml online server to parse the plantuml file on github, and use its full url in github asciidoc files

external image syntax

https://www.gatech.edu/sites/default/files/uploads/images/feature_slides/vanleer_maker_space_slider.jpg

AsciiDoc syntax

:gatechImage: https://www.gatech.edu/sites/default/files/uploads/images/feature_slides/vanleer_maker_space_slider.jpg

This syntax is too long, let’s use an asciidoc variable gatechImage

Easy way to display image in asciidoc on github

In your document

image::{gatechImage}[gatechImage]

Figure 1. Result