Skip to main content

Markdown Syntax

Field that accept markdown support the following syntax.

Paragraphs

Paragraphs are separated by two or more line breaks.

This is the first paragraph,
and this is still the first paragraph.

This is the second paragraph

This is the first paragraph, and this is still the first paragraph.

This is the second paragraph

Bold (Strong)

Bold style can be applied to text by surrounding it with double asterix or double underline.

**Bold text**
__Also bold text__

Bold text

Also bold text

Italic (Emphasis)

Italic style can be applied to text by surrounding it with single asterix or single underline.

*Italic text*
_Also italic text_

Italic text

Also italic text

Strikethrough

Strikethrough style can be applied to text by surrounding it with double tilde.

~~Strikethrough text~~

Strikethrough text

Underline (inserted)

Underlined style can be applied to text by surrounding it with double plus.

++Underlined text++
Underlined text

Highlighted

Highlighted style can be applied to text by surrounding it with double equals. Highlighted text will either be rendered with a background highlight or a font colour.

==Highlighted text==
Highlighted text

Headings

Headings can be applied to a line by prefixing the line with one or more hash characters. Lower heading levels can be used by prefixing the line with extra hash characters. There are six levels of headings.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Quotes

Text can be formatted as quotations by prepending lines with the greater than (right angle) character. Quoted text can be nested.

> This is a quote

This is a quote

Code

The code block is a special code block that doesn't format any text inside the block even if it matches other markdown formatting. Code blocks use a monospaced font. Code can either be formatted inline with a single back tick character, or can be a multiple line block surrounded by three or more back ticks.

`this is code`

this is code

```
This is also code
```
This is also code

Horizontal line

A horizontal line can be added by using three or more dash characters

---

___

Unordered lists (Bullet points)

An unordered (bulleted) list can be added by prepending a line with dash, asterix, or plus symbol

- first bullet point
* second bullet point
+ third bullet point
  • first bullet point
  • second bullet point
  • third bullet point

Ordered lists (Numbered lists)

An ordered (numbered) list can be added by prepending a line with a number followed by a full stop character.

1. first bullet point
2. second bullet point
100. third bullet point
  1. first bullet point
  2. second bullet point
  3. third bullet point

Indented lists

Lists can be indented by prepending a line with a multiple of four characters

1. first bullet point level
1. second bullet point level
1. third bullet point level
  1. first bullet point level
    1. second bullet point level
      1. third bullet point level
* first bullet point level
* second bullet point level
* third bullet point level
  • first bullet point level
    • second bullet point level
      • third bullet point level

Links consist of three parts:

  1. Link text (optional)
  2. Link target
  3. Link alt text (optional)
[Metrhack](https://metrhack.com)

Metrhack

[Metrhack](https://metrhack.com "Home page")

Metrhack

Tables

Tables can be used by drawing vertical pipe characters for vertical table borders and horizontal dash characters for horizontal borders.

| Table heading | also a table heading |
|---|---|
| This is a table cell | this is also a table cell |
Table headingalso a table heading
This is a table cellthis is also a table cell