Using Markdown in DataLens

DataLens allows you to use the Markdown markup language in the Text widget on the dashboard.
You can insert explanatory text, links, tables, images, or use formatting to highlight key points.

In text widgets, you can use the following elements:

• Headers
• Bold and italics
• Lists
  • Simple unordered list
  • Nested unordered list
  • Simple ordered list
  • Nested ordered list
• Tables
• Links
• Code formatting
  • Inline code snippet
  • Code block
• Image
• Cuts

Headers

You can use four levels of headings in the widget.
Use # to mark up headings.

Syntax example:

# Level 1 heading
## Level 2 heading
### Level 3 heading
#### Level 4 heading

Highlighting text

Use formatting to highlight key points in your text:

• To make text bold, use double *:

  This text will be **bold**.
  

• To make text italic, use _:

  This text will be _italic_.
  

• To combine bold and italics, use double * and _ at the same time:

  This text will be _**bold and italic**_.
  This text will be **_bold and italic_**.
  

Lists

You can use multiple list types to arrange the data on the dashboard.

Simple unordered list

To make an unordered bulleted list, use characters such as *, -, or +.

For example, the following markup:

* Item 1
* Item 2
* Item 3

will be displayed as:

• Item 1
• Item 2
• Item 3

Nested unordered list

To make a nested unordered list, add an indent for the lines with the nested list items. The indent can be from two to five spaces.

For example, the following markup:

- Item 1
   - Item A
   - Item B
- Item 2

will be displayed as:

• Item 1
  • Item A
  • Item B
• Item 2

Simple ordered list

To make an ordered list, use numbers with a . or ).

For example, the following markup:

1. First item
1. Second item
1. Third item

will be displayed as:

1. First item
2. Second item
3. Third item

Nested ordered list

To make a nested ordered list, add an indent for the lines with the nested list items. The indent can be from three to six spaces.

For example, the following markup:

1. First item
   1. Nested item
   1. Nested item
1. Second item

will be displayed as:

1. First item

   1.1. Nested item
   
   1.2 Nested item

2. Second item

Tables

A table consists of a single row with headers, a separator row, and rows with data.

Each row in a table consists of cells that are separated from each other by a |.

The cells of the separator row only allow the - character and : character. The colon (:) is used at the beginning, end, or on both sides of the cell content of the separator row to indicate left, right, or center alignment of text in the corresponding column, respectively.

A table should be separated from the surrounding text with empty lines.

For example, the following markup:

Left-aligned | Right-aligned | Centered
:--- | ---: | :---:
Text | Text | Text

will be displayed as:

To add a line break or a more complex element (such as a list or code block) to a table cell, use an alternative markup:

#|
|| **Header1** | **Header2** ||
|| Text | Text ||
|#

Sample markup with line breaks and a list:

#|
||Text
on two lines
|
- Item 1
- Item 2
- Item 3
- Item 4||
|#

See learn more in the YFM documentation.

Links

You can use links to enter information related to the dashboard or charts.
For example, you can add links to other dashboards and specify data sources.

A link consists of two parts:

• [text] is the link text.
• (link) is the URL or path to the file referenced.

For example, the following markup:

[link to yandex.ru](https://yandex.ru).

will be displayed as:

link to yandex.ru.

Code formatting

You can use inline code snippets or code blocks.

Inline code snippet

Use ` to format inline code snippets.

For example, the following markup:

A sentence with a `code snippet`.

will be displayed as:

A sentence with a code snippet.

Code block

Use triple ` and the programming language name to format your snippet as a code block.

For example, the following markup:

    ```kotlin
    val a: Int = 1
    ```

will be displayed as a highlighted Kotlin code snippet:

val a: Int = 1

Image

To insert an image in the widget, use Yandex Object Storage. You can use it for free for up to 1 GB of standard storage per month.

To upload an image to the widget:

1. Open the management console and select Object Storage in the menu on the left.

2. Create a bucket with public access.

3. Upload the image to the bucket

4. Go to the resulting object and click Get link.

5. Copy the link to the image.

6. Go to your DataLens dashboard and create a widget named Text.

7. Paste the following code in the widget:

   ![alt text](https://image_link "Text of a hint displayed when hovering over the image" =100x200)
   

Cuts

Use cuts to hide content. For example, additional information or long blocks of code.

For example, the following markup:

{% cut "Title of the text to cut" %}

The content to be displayed when you click it.

{% endcut %}

will be displayed as: