Использование Markdown в DataLens

DataLens позволяет использовать язык разметки Markdown в виджете Текст на дашборде.
Вы можете разместить поясняющий текст, ссылки, таблицу, изображение или выделить значимые моменты с помощью форматирования.

В текстовых виджетах вы можете использовать следующие элементы:

• Заголовки
• Полужирный шрифт и курсив
• Списки
  • Простой неупорядоченный список
  • Вложенный неупорядоченный список
  • Простой упорядоченный список
  • Вложенный упорядоченный список
• Таблицы
• Ссылки
• Оформление кода
  • Фрагмент кода как часть предложения
  • Фрагмент кода отдельным блоком
• Изображение

Заголовки

Вы можете использовать четыре уровня заголовков в виджете.
Для обозначения заголовка используется символ #.

Пример синтаксиса:

# Заголовок 1 уровня
## Заголовок 2 уровня
### Заголовок 3 уровня
#### Заголовок 4 уровня

Выделение текста

Вы можете выделить важное в тексте с помощью форматирования:

• Чтобы выделить текст полужирным шрифтом, используйте удвоенный символ *:

  Этот текст выделен **полужирным шрифтом**.
  

• Чтобы выделить текст курсивом, используйте символ _:

  Этот текст выделен _курсивом_.
  

• Чтобы выделить текст полужирным шрифтом и курсивом, используйте одновременно удвоенный символ * и символ _:

  Этот текст выделен _**полужирным шрифтом и курсивом**_.
  Этот текст выделен **_полужирным шрифтом и курсивом_**.
  

Списки

Вы можете использовать несколько вариантов списков для структурирования информации на дашборде.

Простой неупорядоченный список

Чтобы оформить неупорядоченный маркированный список, используйте символы *, - или +.

Например, следующая разметка:

* Элемент 1
* Элемент 2
* Элемент 3

будет отображаться так:

• Элемент 1
• Элемент 2
• Элемент 3

Вложенный неупорядоченный список

Чтобы оформить вложенный неупорядоченный список, добавьте отступ в начале строк с элементами вложенного списка. Допустимый размер отступа — от двух до пяти пробелов.

Например, следующая разметка:

- Элемент 1
   - Элемент A
   - Элемент B
- Элемент 2

будет отображаться так:

• Элемент 1
  • Элемент A
  • Элемент B
• Элемент 2

Простой упорядоченный список

Чтобы оформить упорядоченный список, используйте цифры с символом . или ).

Например, следующая разметка:

1. Первый пункт
1. Второй пункт
1. Третий пункт

будет отображаться так:

1. Первый пункт
2. Второй пункт
3. Третий пункт

Вложенный упорядоченный список

Чтобы оформить вложенный упорядоченный список, добавьте отступ в начале строк с элементами вложенного списка. Допустимый размер отступа — от трех до шести пробелов.

Например, следующая разметка:

1. Первый пункт
   1. Вложенный пункт
   1. Вложенный пункт
1. Второй пункт

будет отображаться так:

1. Первый пункт

   1.1. Вложенный пункт
   
   1.2. Вложенный пункт

2. Второй пункт

Таблицы

Таблица состоит из одной строки с заголовками, разделительной строки и строк с данными.

Каждая строка таблицы состоит из ячеек, отделенных друг от друга символами |.

В ячейках разделительной строки используются только символ - и символ :. Символ : ставится в начале, в конце или с обеих сторон содержимого ячейки разделительной строки, чтобы обозначить выравнивания текста в соответствующем столбце по левой стороне, по правкой стороне или по центру соответственно.

Таблицу нужно отделять от предшествующего и последующего текста пустыми строками.

Например, следующая разметка:

По левому краю | По правому краю | По центру
:--- | ---: | :---:
Текст | Текст | Текст

будет отображаться так:

Если необходимо добавить в ячейку таблицы перенос строки или более сложный элемент (например, список или блок кода), воспользуйтесь альтернативной разметкой:

#|
|| **Заголовок1** | **Заголовок2** ||
|| Текст | Текст ||
|#

Пример разметки с переносами и списком:

#|
||Текст
на двух строчках
|
- Пункт 1
- Пункт 2
- Пункт 3
- Пункт 4||
|#

См. подробнее в документации YFM.

Ссылки

С помощью ссылок вы можете указать информацию, которые имеет отношение к дашборду или чартам.
Например, добавить ссылки на другие дашборды, указать источники данных.

Ссылка состоит из двух частей:

• [текст] — текст ссылки.
• (ссылка) — URL или путь до файла, на который делается ссылка.

Например, следующая разметка:

[ссылка на yandex.ru](https://yandex.ru).

будет отображаться так:

ссылка на yandex.ru.

Оформление кода

Фрагмент кода можно оформить как часть предложения или как отдельный блок.

Фрагмент кода как часть предложения

Чтобы оформить фрагмент кода как часть предложения, используйте символ `.

Например, следующая разметка:

Предложение с `фрагментом кода`.

будет отображаться так:

Предложение с фрагментом кода.

Фрагмент кода отдельным блоком

Чтобы оформить фрагмент кода как отдельный блок, используйте утроенный символ ` и имя соответствующего языка программирования.

Например, следующая разметка:

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

будет отображаться как фрагмент кода на языке Kotlin с подсветкой:

val a: Int = 1

Изображение

Чтобы разместить изображение в виджете, воспользуйтесь облачным сервисом Yandex Object Storage. Сервис бесплатен, если у вас не больше 1 ГБ хранения в стандартном хранилище в месяц.

Для загрузки изображения в виджет:

1. Откройте консоль и в меню слева выберите Object Storage.
2. Создайте бакет с публичным доступом.
3. Загрузите изображение в бакет.
4. Перейдите в полученный объект и нажмите кнопку Получить ссылку.
5. Скопируйте ссылку на изображение.
6. Перейдите в ваш дашборд сервиса DataLens и создайте виджет Текст.
7. Вставьте в виджет следующий код:

   ![alt text](https://ссылка_на_изображение "Текст для подсказки при наведении" =100x200)