Skip to content

Tables, Tabs & Lists

Tables

Use Tables to organize content in columns and rows. To create a Table use a pipe (|) to separate columns, use a hyphen (-) as delimiter between the header row and the body and a colom (:) to align the contents in the column.

| Column 1 (Left Aligned)   | Column 2 (Centered)   | Column 3 (Right Aligned)  |
| :-                        | :-:                   | -:                        |
| Value 1.1                 |  Value 2.1            | Value 3.1                 |
| Value 1.2                 |  Value 2.2            | Value 3.2                 |
| Value 1.3                 |  Value 2.2            | Value 3.2                 |
Column 1 (Left Aligned) Column 2 (Centered) Column 3 (Right Aligned)
Value 1.1 Value 2.1 Value 3.1
Value 1.2 Value 2.2 Value 3.2
Value 1.3 Value 2.2 Value 3.2

Tables can include other type of Markdown e.g. to include Text formatting, Icons or Inline Code.

| Method    | Description                     |
| :-        | :-                              |
| `GET`     | :material-check:     **Fetch**  |
| `PUT`     | :material-check-all: ^^Update^^ |
| `DELETE`  | :material-close:     ~~Delete~~ |
Method Description
GET Fetch
PUT Update
DELETE Delete

Tip

If you need to include a paragraph in a cell use the HTML Line Break element <BR>

Syntax Result
Line without break Line without break
Line with <BR> break Line with
break

Tabs

Use Tabs to organize content in groups, where each group is a separate Tab. To create a group of Tabs start a line with three equal signs (===) to create a Tab. On the next line create the content of the Tabs, indented by four spaces.

=== "Tab 1"
    Content on Tab 1

=== "Tab 2"
    Content on Tab 2

Content on Tab 1

Content on Tab 2

Tabs can include any type of Markdown such as Code Blocks.

```python title=""
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]
```

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]

Tabs can be nested in other Tabs.

=== "Tab 1"
    This is Tab 1
    === "Tab 1.1"
        This is Tab 1.1
    === "Tab 1.2"
        This is Tab 1.2

=== "Tab 2"
    This is Tab 2
    === "Tab 2.1"
        This is Tab 2.1
    === "Tab 2.2"
        This is Tab 2.2

This is Tab 1

This is Tab 1.1

This is Tab 1.2

This is Tab 2

This is Tab 2.1

This is Tab 2.2

Tabs can be nested in other Markdown blocks such as Adminitions.

!!! example
    === "Tab 1"
        Content on Tab 1

    === "Tab 2"
        Content on Tab 2

Example

Content on Tab 1

Content on Tab 2

Lists

Use Lists to create a hierarchy of items. To create a list start a line with a plus (+) sign for an unordered list, a nmber 1. (1.) for an ordered list, a plus sign with brackets (+ [ ]) for a task list and backticks (``) for a definition list.

+ Item 1
    + Item 1.1
    + Item 2.2
+ Item 2
+ Item 3
  • Item 1
    • Item 1.1
    • Item 2.2
  • Item 2
  • Item 3
1. Item 1
    1. Item 1.1
    1. Item 2.2
1. Item 2
1. Item 3
  1. Item 1
    1. Item 1.1
    2. Item 2.2
  2. Item 2
  3. Item 3
+ [ ] Task 1
    + [ ] Task 1.1
    + [x] Task 2.2
+ [x] Task 2
+ [ ] Task 3
  • Task 1
    • Task 1.1
    • Task 2.2
  • Task 2
  • Task 3
`Definition 1`
: Definition 1 is all about something...

`Definition 2`
: Definition 2 is all about something else...
Definition 1
Definition 1 is all about something...
Definition 2
Definition 2 is all about something else...

Tip

If you need to include a paragraph in a List, include a whiteline and indent the line with an additional four spaces.

+ Item 1

    My paragraph

+ Item 2

  • Item 1

    My paragraph

  • Item 2