Markdown guide

Introduction

What is Markdown?
Markdown is a lightweight markup language with plain text formatting syntax aimed for web writers. It allows you to easily write text, without the need or help of external tools or a user interface, that later will be formatted as HTML while maintaining readability. Markdown can be used instead of or in conjunction of text formatted with BBCode.
Top

Text formatting

Creating bold text
To make a piece of text bold, enclose it in a pair of ** or __, e.g.
**Hello**
or
__Hello__
will become

Hello
Top
Creating italic text
To italicise text, enclose it in a pair of * or _, e.g.
*Great!*
or
_Great!_
will become

Great!
Top
Creating strikethrough text
To strikethrough text, enclose it in a pair of ~~, e.g.
~~Good morning~~
will become

Good morning
Top
Creating subscript text
To create subscript text, enclose it in a pair of ~, e.g.
H~2~O
will become

H2O
Top
Creating superscript text
To create a superscript text, add ^ before the text, e.g.
2^n
will become

2n
Top
Creating headers
To create headers, add from 1 up to 6 # followed by a space before the text. The higher the number, the smaller the text would be, e.g.
# H1
## H2
### H3
#### H4
##### H5
###### H6
will become

H1

H2

H3

H4

H5
H6
Top

Quoting and outputting fixed-width text

Quoting text in replies
To quote text, add > and optionally an space before the text line, e.g.
> Quoted text
will become
Quoted text

Top
Outputting code
To output code, enclose it in a pair of ``` or ~~~, or alternatively add 4 empty spaces before each line. You can also specify the language in the first marker, e.g.
```ruby
puts "Hello #{user}!"
```
will become
puts "Hello #{user}!"
Top
Outputting inline code
To output inline code, enclose it in pair of ` or ``, e.g.
`<div>` tag
or
``<div>`` tag
will become

<div> tag
Top

Generating lists

Creating unordered list
To create an unordered list, add *, - or + followed by an space before each list item. Lists can be nested by adding 4 additional spaces or a tab to create a sublevel, e.g.
- Element
- Subelement
- Element
will become

  • Element
    • Subelement
  • Element
Top
Creating ordered list
To create an ordered list, add a digit followed by a dot and a space, e.g.
1. Element
1. Subelement
2. Element
will become

  1. Element
    1. Subelement
  2. Element
Top

Creating links

Linking to another site
To create links, add the link text inside square brackets followed by the link URL inside parentheses, e.g.
[Link text](http://example.org)
will become

Link text
Top

Showing images

Adding images
To show an image, add an exclamation mark followed by the image alternate text inside square brackets and then the image URL inside parenthesis, e.g.
![phpBB](https://www.phpbb.com/assets/images/images/logos/blue/160x52.png)
will become

phpBB
Top

Extras

Creating tables
To create tables, add a line of text divided with | which will be the table headers, after that a new line with - and optionally : to the left, on both sides or to the right to align the text of that column, again divided with |. All successive lines divided with | will be rendered as table rows, e.g.
| Left | Center | Right |
|:-----|:------:|------:|
| x | x | x |
or
Left|Center|Right
:-|:-:|-:
x|x|x
will become

LeftCenterRight
xxx
Top
Creating horizontal rules
To create a horizontal rule, add at least 3 *, - or _ optionally separated with a space, e.g.
***
* * *
---
- - -
___
_ _ _
will become


Top