Getting Started with Paligo

Table of Contents

Cheat Sheet for AsciiDoc Markdown

This is a cheat sheet with some of the AsciiDoc format supported by the Paligo Markdown Editor.

Headers

== Level 1
Text.

Level 1

Text.

=== Level 2
Text.

Level 2

Text.

==== Level 3
Text.

Level 3

Text.

===== Level 4
Text.
Level 4

Text.

Text and inline formatting

Regular paragraph, just use space 
above and below.

Regular paragraph, just use space above and below.

_italic_  *bold*

italicbold

^superscript^  ~subscript~

superscriptsubscript

kbd:[Ctrl + Alt + N]

Ctrl+Alt+N

Source code

`Inline code`

Inline code

[source,java]
--------
/**
 * @author John Smith <john.smith@example.com>
*/
package l2f.gameserver.model;

public abstract class L2Char extends L2Object {
  public static final Short ERROR = 0x0001;

  public void moveTo(int x, int y, int z) {
    _ai = null;
    log("Should not be called");
    if (1 > 5) { 
      return;
    }
  }
}
--------
/**
 * @author John Smith <john.smith@example.com>
*/
package l2f.gameserver.model;

public abstract class L2Char extends L2Object {
  public static final Short ERROR = 0x0001;

  public void moveTo(int x, int y, int z) {
    _ai = null;
    log("Should not be called");
    if (1 > 5) {
      return;
    }
  }
}

Lists and procedures

* listitem
* listitem
+
A second para in the list item.

** listitem
** listitem
*** listitem
*** listitem
* listitem
  • listitem 

  • listitem 

    A second para in the list item.

    • listitem 

    • listitem 

      • listitem 

      • listitem 

  • listitem 

. listitem
. listitem
.. listitem 
.. listitem 
... listitem 
...
. listitem 
  1. listitem 

  2. listitem 

    1. listitem 

    2. listitem 

      1. listitem 

      2. listitem 

  3. listitem 

. listitem
. listitem

//Start a new list right after another
using a comment (the slashes are enough)

. listitem
. listitem
  1. listitem 

  2. listitem 

  1. listitem

  2. listitem

[role='procedure']
.Optional title
. listitem
. listitem
.. listitem 
.. listitem 
... listitem 
...
. listitem 
Optional title
  1. listitem 

  2. listitem 

    1. listitem 

    2. listitem 

      1. listitem 

      2. listitem 

  3. listitem 

Term:: Definition
Term:: Definition
Term:: Definition
Term

Definition

Term

Definition

Term

Definition

Tables

[options="header"]
|=============== 
 |Header |Header
 |Cell |Cell
 |Cell |Cell
|=============== 

Header

Header

Cell

Cell

Cell

Cell

.Complex table, title, width, 
and header
[width="50%"]
[options="header"]
|=============== 
 |Header |Header
 2+|Cell content in a cell that 
spans two columns.
 .2+|Cell content in a cell 
that spans two rows. |Cell
 |Cell
|===============
Table 1. Complex table, title, width, and header 

Header

Header

Cell content in a cell that spans two columns to make more complex tables.

Cell content in a cell that spans two rows.

Cell

Cell



Images

image::#UUID-a4cae6e9-1073-512d-af50-34675f85c9bf[]

Images are inserted mainly by the toolbar icon. The uuid identifies it.

.Optional title makes it a labeled figure
image::#47943[My image caption]

The short id works too. Text in the brackets become a caption.

Figure 1. Optional title makes it a labeled figure
Optional title makes it a labeled figure

My image caption



One colon instead of two makes it 
an inlinemediaobject instead, for icons 
image:#48849[] and the like.

One colon instead of two makes it an inlinemediaobject instead, for icons and the like.

Admonitions/hazard statements

[NOTE]
--
This is a note.
--


Note

This is a note.

[CAUTION]
--
This is a caution.
--


Caution

This is a caution.

[WARNING]
--
This is a warning.
--


Warning

This is a warning. 

[IMPORTANT]
--
This is an important note.
--


Important

This is an important note.

[TIP]
--
This is a tip.
--


Tip

This is a tip.

For more details on AsciiDoc format, there are many resources available online, such as this and this.