Markdown Formatting

Modified on Fri, 19 Apr at 3:52 PM

Many text fields in QReserve support a subset of the Markdown formatting language to add styles and structure to your text. Look for the Markdown Enabled indicator in the bottom right corner of a text field to know if it is available.

Markdown Overview

Markdown is a formatting language that allows you to change the underlying HTML code of text without having to write any actual HTML code. The implementation of Markdown in QReserve is restricted to a subset of the full language to ensure security and reliability; however, it still provides a range of options for communicating information in a clear and structured manner.

Block Quotes

Use the > symbol to isolate a section of text into a blockquote.

Markdown Code

This is normal text.
> This text will
> show up in a blockquote.

This is normal text.

Rendered Output

This is normal text.

This text will show up in a blockquote.

This is normal text.

Bold and Italic Text

Encase text in single asterisk * for italic text, or double, ** for bold text.

Markdown Code

This is *italic* and this is **bold**.

Rendered Output

This is italic and this is bold.

Headers

Headers are rendered as larger fonts as the HTML <H1> through <H6> tags and are specified with 1 through 6 leading # symbols.

Markdown Code

###### Header 6
##### Header 5
#### Header 4
### Header 3
## Header 2
# Header 1

Rendered Output

Header 6

Header 5

Header 4

Header 3

Header 2

Header 1

Ordered and Unordered Lists

A list can be defined by separating the first and last items with a blank line and then an unordered starts each item with an asterisk while and ordered list starts each item with a number followed by a period (e.g. 1. 2. 3.). A sub-list can be created by indenting a list item by exactly 4 spaces.

Markdown Code

Here is an unordered list:
* Item 1
* Item 2
   * Indented item 1
   * Indented item 2
* Item 3
While  here is an ordered list:

1. Ordered Item 1
2. Ordered Item 2
3. Ordered Item 3

Rendered Output

Here is an unordered list:

Item 1
Item 2
- Indented item 1
- Indented item 2
Item 3

While here is an ordered list:

Ordered Item 1
Ordered Item 2
Ordered Item 3

Links to Websites

A website link can be entered using link text.

Markdown Code

Visit the [QReserve website](https://get.qreserve.com) for more information.

Rendered Output

Visit the QReserve website for more information.

Images

Images can be inserted by clicking the picture icon in the toolbar and uploading the image. The required Markdown code will automatically be inserted with a blank area to add an image description. The URL for the image is automatically generated and cannot be changed. Only images uploaded through this process will work within the application. Accepted image formats include JPEG and PNG.

Markdown Code

My image:
![Description Text](https://api.../f/..../myimage.png) for more information.

Rendered Output

My image:

Horizontal Rulers

You can insert a horizontal ruler, or line, using a series of asterisks on their own line.

Markdown Code

This is some  normal text.
*****
This is some more text.

Rendered Output

This is some normal text.

This is some more text.

Highlighted or Marked Text

Encase text in double equal signs to highlight the text.

Markdown Code

This is ==very important== information.

Rendered Output

This is very important information.

Fixed Width Font

You can use a fixed width typewriter font by enclosing text with back ticks.

Markdown Code

This is some `typewriter text` in a line.

Rendered Output

This is some typewriter text in a line