Skip to main content
Version: Release 23.1

Using Markdown in Release

In Release, you can use Markdown syntax to style your text in various ways. Markdown is a simple and intuitive way to format text, which includes headers, hyperlinks, italics, and more. Markdown is supported in three areas of Release: task descriptions, script task output, and comments.

Headers​

Use one to six hash symbols (#) to create headings of different levels.

# Header 1

## Header 2

### Header 3

#### Header 4

##### Header 5

###### Header 6

The simplest way to create a clickable hyperlink in Markdown is to enter a web site address starting with http:// or https://.

Visit our documentation at https://docs.digital.ai/.

To create a hyperlink, enclose the link text in square brackets [ ] and the URL in parentheses ( ).

Please visit the [Digital.ai website](https://digital.ai/).

Bold and Italics​

Use double asterisks (**) for bold text and single asterisk (*) for italicized text.

Choose between **bold** and *italic*.

Code Highlighting​

Use backticks (`) to indicate inline code, and use triple backticks (```) to indicate a block of code.

demo code {
    color: #efefef;
    padding: 5;
}

Lists​

To create a bullet list, use an asterisk (*) or a hyphen (-) at the beginning of each item followed by a space.

Bulleted list:

* One item
* Another item

To create a numbered list, use a number followed by a period (.) at the beginning of each item.

Note: In Markdown, when you create a numbered list, the numbering doesn't have to be exact because Markdown will calculate the proper order for you. You can start each item in the list with any number, and Markdown will automatically adjust the numbering to create a correctly ordered list.

Numbered list:

1. First item
2. Second item
3. Last item

More information​

Markdown actually offers a wide range of formatting options. If you want a more comprehensive explanation of all the different Markdown commands and options available, we recommend checking out the official Markdown documentation. It provides a full breakdown of all the syntax options, including how to create tables, add images, use blockquotes, and more. For a full explanation, see the Markdown guide by John Gruber.