Markdown Formatting

Introduction

Markdown is a lightweight markup language for creating formatted text using a plain-text editor.

Hypertable supports Markdown formatting of text in a number of text inputs, including Multi-line Text fields, the Project description, and others.

Contents

• Text Attributes
• Headings
• Lists
• Links
• Images
• Horizontal Rule
• Blockquotes & Code Blocks
• Tables
• Inline HTML

Text Attributes

Text can be made bold by using **double asterisks**.

Text can be italicised by using *single asterisks*.

Text can be displayed as inline code by using `single backticks`.

Text can be struck through by using ~~double tildes~~.

Headings

Headings can be added by using a number of # characters equal to the heading level. For example:

Heading 1

Heading 2

Heading 3

Heading 4

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Lists

Both ordered lists (using numbers) and unordered lists (using bullet points) can be defined.

Unordered lists are defined using dashes. For example:

• A list
• can contain
  • nested items
    • using two leading spaces
• and nested ordered items
  1. One
  2. Two

- A list
- can contain
  - nested items
    - using two leading spaces
- and nested ordered items
  1. One
  2. Two

Ordered lists are defined using dashes. For example:

1. First item
2. Second item
   • Nested unordered items
   • Using 3 spaces
3. Third item

1. First item
2. Second item
   - Nested unordered items
   - Using **3 spaces**
3. Third item

Links

Hyperlinks can be added linking to any web page like example.com like this:

The link to [example.com](https://www.example.com)

Images

Images can be displayed from any URL, like this placeholder image:

The syntax is similar to that of hyperlinks, but note the leading !:

![Alt text description](https://via.placeholder.com/234x123)

Horizontal Rule

A horizontal rule can be added by using three dashes. For example:

Above

Below

Above

---

Below

Note: There must be an empty line above the dashes, otherwise the text above will be converted to a heading.

Blockquotes & Code Blocks

Blockquotes are defined by starting the line with a > and a space

...and can have multiple lines.

> Blockquotes are defined by starting the line with a `>` and a space
>
> ...and can have multiple lines.

Blocks of code can be defined by surrounding the lines with three ` characters. For example, to display this function:

function add(a, b) {
  return a + b;
}

you would need to enter this:

```
function add(a, b) {
  return a + b;
}
```

Without the surrounding ``` characters, the text displays in normal paragraphs.

Tables

A simple table can be defined like this:

First Name | Favourite Colour
--- | ---
Alice | Aqua
Bob | Brown
Charlie | Cyan

Inline HTML

Many common HTML tags can be included in Markdown text.

Many common <abbr title="Hypertext Markup Language">HTML</abbr> tags
can be included in <span style="color: HotPink">Markdown</span> text.

Do you think something is missing from the docs? Let us know