Editor Formatting Reference - TestRail

Editor formatting reference

Some fields in TestRail allow for rich text formatting. You can use rich text formatting in TestRail by using an easy to learn syntax called Markdown.

For example, to make a word appear italic, just surround it with asterisks like *this*. Likewise, to make a word appear bold, surround it with two **asterisks**.

There are syntax elements to make lists, add links, include code blocks, headers, images, and a lot more. Please see below for a list of available syntax options and for examples on how to use them.

The syntax reference and highlighting were inspired by Stack Overflow.

Italics and bolds

There are multiple ways to emphasize words:

Code and preformatted text

To make a code block, indent four spaces:

The text will be wrapped in tags and displayed in a monospaced typeface. The first four spaces will be stripped off, but all other whitespace will be preserved.

You cannot use Markdown or HTML within a code block, which makes them a convenient way to show samples of Markdown or HTML syntax:

If code blocks are embedded in text blocks, they require an empty line before and after.

Code spans

Use backticks to create an inline <code> span:

(The backtick key is in the upper left corner of most keyboards.)

Links

There are two ways to write links. The second one is easier to read than the first:

The link definitions can appear anywhere in the document — before or after the place where you use them.

Headers

You can underline text to make the two top-level headers:

The number of = or – signs does not matter. You can get away with just one. But using enough to underline the text makes your titles look better in plain text.

You can also use hash marks for several levels of headers:

The closing # characters are optional.

Horizontal rules

You can insert a horizontal rule by putting three or more hyphens, asterisks, or underscores on a line by themselves:

You can also use spaces between the characters:

All of these examples produce the same output.

Simple lists

A bulleted list:

A numbered list:

A double-spaced list:

Blockquotes

Blockquotes are indented:

Images

Images are exactly like links, but they have an exclamation point in front of them:

The word in square brackets is the alt text which appears if the browser can’t show the image. Be sure to include meaningful alt text for screen-reading software.

Tables

Requires TestRail 5.0 or later. Tables can be formatted as follows:

The first line specifies the table header and column alignments. The alignments are determined by colon characters in the respective header cells at the beginning/end of the cells. The following alignments are supported:

:Header Left-aligned (default)
:Header: Centered
Header: Right-aligned

The table cells themselves support a limited set of rich-text formatting. The following features are supported inside a table cell:

Advanced lists

You can put other Markdown blocks in a list. Simply indent four spaces for each nesting level:

Advanced blockquotes

You can put other Markdown blocks in a blockquote. To do so, add a > followed by a space: