Skip to content

Markdown Formatting

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 enabled text field

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.

This is normal text. > This text will > show up in a blockquote. This is normal text.
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.

This is *italic* and this is **bold**.
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.

###### Header 6 ##### Header 5 #### Header 4 ### Header 3 ## Header 2 # Header 1
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.

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

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

A website link can be entered using link text.

Visit the [QReserve website](https://get.qreserve.com) for more information.
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.

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

Horizontal Rulers

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

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

Highlighted or Marked Text

Encase text in double equal signs to highlight the text.

This is ==very important== information.
This is very important information.

Fixed Width Font

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

This is some `typewriter text` in a line.
This is some typewriter text in a line.