Markdown

The whole website and the forum in particular use markdown to format the content of pages and forum posts.
This page summarizes the different syntaxes to use.

Paragraphs

To create a new paragraph, you just have to jump a blank line, or in other words make two line breaks in a row.

Unlike many other markdown implementations, a single line break without a blank line adds a single line break (BR tag in HTML).
In addition, the HTML code is not interpreted as is for security reasons.

Links

URLs with the form protocol://source are automatically transformed into links.

The syntax for creating a link with custom text is: [text](URL). The text of the link in square brackets, followed by the URL in parentheses without spaces.

Example:


[Google](http://www.google.com/) is your friend.

Result:
Google is your friend.

Bold, italic and strikethrough

To put text in bold, italic or strikethrough, you need to enclose the text between symbols:

Example:


This text is *italic*, this one is **bold**, and this one is ~~strikethrough~~.

Result:
This text is italic, this one is bold, and this one is strikethrough.

Headings

A heading is indicated with the number sign (#) at the beginning of the line. The number of # characters from 1 to 3 indicates the level of the heading.

Example:


## This is a title

Result:

This is a title

Bulleted lists

Each item in a bulleted list begins with a dash, and the text of the item is separated from the dash by a space:

Example:


- Item 1
- Item 2
- Item 3

Result:

Bulleted lists can be nested. To do this, the sub-items must be indented with at least two spaces.

Example:


- Item 1
  - Item 1.1
  - Item 1.2
- Item 2
  - Item 2.1
  - Item 2.2

Result:

Numbered Lists

Each item in a numbered list begins with its number, followed by a dot and a space.
The form of the first number indicates the type of list and the starting number. There are five possible numberings:

Example:


1. Item 1
2. Item 2
3. Item 3
A. Item 1
B. Item 2
C. Item 3

Result:

  1. Item 1
  2. Item 2
  3. Item 3
  1. Item 1
  2. Item 2
  3. Item 3

Numbered lists can be nested. To do this, the elements of the sub-list must be indented with at least two spaces.
Different numberings can be used in nested lists.

Example:


1. Item 1
  a. Item 1a
  b. Item 1b
2. Item 2
  a. Item 2a
  b. Item 2b

Result:

  1. Item 1

    1. Item 1a
    2. Item 1b

  2. Item 2

    1. Item 2a
    2. Item 2b

It is possible to start a list at something other than 1 or A. It is also possible to write a list backwards.

Example:


3. Bronze medal
2. Silver medal
1. Gold Medal
5. A list that starts at 5
6. Item 6
7. Item 7
K. A list that starts with K
L. Item L
M. Item M

Result:

  1. Bronze medal
  2. Silver medal
  3. Gold Medal
  1. A list that starts at 5
  2. Item 6
  3. Item 7
  1. A list that starts with K
  2. Item L
  3. Item M

Backwards lists are not supported by Internet Explorer

Quotes

Block quotes are useful for quoting a previous post in the forum. A block quote paragraph starts with a > sign at the beginning of the line.
The > sign can be repeated at the beginning of each line, but it is not required.

Example:


>; To be or not to be, that is the question

Result:

To be or not to be, that is the question

Dividing line

A separating line can be created by writing a sequence of at least three single symbols on a line among the following: *+-=~.

Example:


*****

Result:

Tables

Table cells are delimited with vertical bars (|). Left and right borders can, but do not have to be indicated.
The cells in the first row automatically become header cells. A table must have at least two rows and two columns.

Example:


Name | Score
Alice | 53
Bob | 48
Cedric | 41
David | 37
1 | 2 | 3 | 4
5 | 6 | 7 | 8
9 | 10 | 11 | 12
13 | 14 | 15 | 16

Result:

Name Score
Alice 53
Bob 48
Cedric 41
David 37
1 2 3 4
5 6 7 8
9 10 11 12
13 14 15 16

Code

A code block is delimited by three back quotes (`). Code blocks are useful for demonstrating how to write markdown!

Reserved characters

To prevent a given character from being interpreted within the framework of one of the syntaxes described on this page, so that it is always displayed as is, it can be escaped by preceding it with a backslash (\).

Images and media

To add an image or media, the syntax is the same as for a link except that the opening bracket is preceded by an exclamation mark.
Media types are recognized by their URL and displayed accordingly:

Examples:


![Playroom logo](images/logo.svg) Playroom logo
![The loser music by Aminiel](http://vrac.quentinc.net/loser4h.ogg)
![Surprise video](http://youtu.be/dQw4w9WgXcQ)
Playroom logo

Playroom logo