Examples

Titles

Title level 1

Title level 2

Title level 3

Syntax :

=Title level 1=
==Title level 2==
===Title level 3===

Formating

Bold text
italic text
link

Quotation

Text highlight
Highlight monospaced text
Displaying an icon
Syntax :

**Bold text**
//italic text//
[[google.com | link]]
> Quotation
!!Text highlight!!
`Highlight monospaced text`
{icon exclamation-triangle} Displaying an icon

See FontAwesome for list of icon

Lists

  • Bullet point 1
  • Bullet point 2
  • Bullet point 3
  1. Numbered list item 1
  2. Numbered list item 2
  3. Numbered list item 3

Syntax :

* Bullet point 1
* Bullet point 2
* Bullet point 3

# Numbered list item 1
# Numbered list item 2
# Numbered list item 3

Table

Header 1Header 2
Cell 1.1Cell 1.2
Cell 2.1Cell 2.2

Syntax :

| Header 1 | Header 2 |
| ----------- | ----------- |
| Cell 1.1    | Cell 1.2    |
| Cell 2.1    | Cell 2.2    |

Separation


Syntax :

----

Examples

Preformated text
title
Preformated named text
title
Preformated named counterexaple text

Syntax :

title
Preformated named text

name=title,counterexample
Preformated named counterexaple text

Uml

Exception in thread "main" java.lang.InternalError: java.lang.reflect.InvocationTargetException
	at java.desktop/sun.font.FontManagerFactory$1.run(FontManagerFactory.java:86)
	at java.base/java.security.AccessController.doPrivileged(Native Method)
	at java.desktop/sun.font.FontManagerFactory.getInstance(FontManagerFactory.java:74)
	at java.desktop/sun.font.SunFontManager.getInstance(SunFontManager.java:249)
	at java.desktop/sun.font.FontDesignMetrics.getMetrics(FontDesignMetrics.java:265)
	at java.desktop/sun.java2d.SunGraphics2D.getFontMetrics(SunGraphics2D.java:869)
	at net.sourceforge.plantuml.Run.forceOpenJdkResourceLoad(Run.java:251)
	at net.sourceforge.plantuml.Run.main(Run.java:155)
Caused by: java.lang.reflect.InvocationTargetException
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:490)
	at java.desktop/sun.font.FontManagerFactory$1.run(FontManagerFactory.java:84)
	... 7 more
Caused by: java.lang.RuntimeException: Fontconfig head is null, check your fonts or fonts configuration
	at java.desktop/sun.awt.FontConfiguration.getVersion(FontConfiguration.java:1271)
	at java.desktop/sun.awt.FontConfiguration.readFontConfigFile(FontConfiguration.java:225)
	at java.desktop/sun.awt.FontConfiguration.init(FontConfiguration.java:107)
	at java.desktop/sun.awt.X11FontManager.createFontConfiguration(X11FontManager.java:719)
	at java.desktop/sun.font.SunFontManager$2.run(SunFontManager.java:379)
	at java.base/java.security.AccessController.doPrivileged(Native Method)
	at java.desktop/sun.font.SunFontManager.<init>(SunFontManager.java:324)
	at java.desktop/sun.awt.FcFontManager.<init>(FcFontManager.java:35)
	at java.desktop/sun.awt.X11FontManager.<init>(X11FontManager.java:56)
	... 12 more

See PlantUml for detailled documentation

Step 1Step 2Step 3

Syntax :

{nav Step 1 > Step 2 > Step 3}

Notes

NOTE: Note information
WARNING: Warning information
IMPORTANT: Important information

Syntax :

NOTE: Note information

WARNING: Warning information

IMPORTANT: Important information

Preview

choosing the icon
setting the preview text