Markdown¶

Lists¶

Unordered list¶

one
two
- three
four

Ordered list¶

one
two
1. three
four

Definition list¶

Lorem ipsum dolor sit amet

Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus tellus non sem sollicitudin, quis rutrum leo facilisis.

Cras arcu libero

Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin ut eros sed sapien ullamcorper consequat. Nunc ligula ante.

Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis. Nam vulputate tincidunt fringilla. Nullam dignissim ultrices urna non auctor.

Formatting¶

This is bold
This is italic
This is marked
This is underlined
This is ~~strikethrough~~
This is inline code

Call-outs (admonitions)¶

Basic¶

Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

With title¶

Phasellus posuere in sem ut cursus

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Without any title¶

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Collapsible blocks¶

Collapsed by default

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Expanded by default

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Supported types¶

Tip

Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Abstract

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Info

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Tip

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Success

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Question

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Warning

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Failure

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Danger

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Bug

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Example

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Quote

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Tabs¶

First tab with codeSecond tab with codeThird tab with list

#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
  return 0;
}

#include <iostream>

int main(void) {
  std::cout << "Hello world!" << std::endl;
  return 0;
}

one
two
three

Tables¶

Method	Description
`GET`	Fetch resource
`PUT`	Update resource
`DELETE`	Delete resource

Code blocks¶

Code block with a title, linenumbers and some highlighted lines

bubble_sort.py
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

Images¶

Regular image¶

With a caption¶

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Centered¶

Footnotes¶

Lorem ipsum¹ dolor sit amet

Multiline² footnote

Or a footnote³ without a number

consectetur adipiscing elit ↩
This is a multiline footnote ↩
no number ↩