Markdown
DataLens позволяет использовать язык разметки Markdown в виджете Текст на дашборде.
Вы можете разместить поясняющий текст, ссылки, таблицу, изображение или выделить значимые моменты с помощью форматирования.
В текстовых виджетах вы можете использовать следующие элементы:
- Заголовки
- Полужирный шрифт и курсив
- Цвет текста
- Списки
- Таблицы
- Ссылки
- Оформление кода
- Изображение
- Каты
- Всплывающие подсказки
Заголовки
Вы можете использовать четыре уровня заголовков в виджете.
Для обозначения заголовка используется символ #
.
Пример синтаксиса:
# Заголовок 1 уровня
## Заголовок 2 уровня
### Заголовок 3 уровня
#### Заголовок 4 уровня
Выделение текста
Вы можете выделить важное в тексте с помощью форматирования:
-
Чтобы выделить текст полужирным шрифтом, используйте удвоенный символ
*
:Этот текст выделен **полужирным шрифтом**.
-
Чтобы выделить текст курсивом, используйте символ
_
:Этот текст выделен _курсивом_.
-
Чтобы выделить текст полужирным шрифтом и курсивом, используйте одновременно удвоенный символ
*
и символ_
:Этот текст выделен _**полужирным шрифтом и курсивом**_. Этот текст выделен **_полужирным шрифтом и курсивом_**.
Цвет текста
Вы можете задать цвет текста с помощью форматирования: {цвет}(текст)
. Поддерживаются следующие значения цвета:
- gray — серый;
- yellow — желтый;
- orange — оранжевый;
- red — красный;
- green — зеленый;
- blue — синий;
- violet — фиолетовый.
Например, следующая разметка:
Этот текст {green}(зеленого) цвета.
будет отображаться так:
Этот текст зеленого цвета.
Списки
Вы можете использовать несколько вариантов списков для структурирования информации на дашборде.
Простой неупорядоченный список
Чтобы оформить неупорядоченный маркированный список, используйте символы *
, -
или +
.
Например, следующая разметка:
* Элемент 1
* Элемент 2
* Элемент 3
будет отображаться так:
- Элемент 1
- Элемент 2
- Элемент 3
Вложенный неупорядоченный список
Чтобы оформить вложенный неупорядоченный список, добавьте отступ в начале строк с элементами вложенного списка. Допустимый размер отступа — от двух до пяти пробелов.
Например, следующая разметка:
- Элемент 1
- Элемент A
- Элемент B
- Элемент 2
будет отображаться так:
- Элемент 1
- Элемент A
- Элемент B
- Элемент 2
Простой упорядоченный список
Чтобы оформить упорядоченный список, используйте цифры с символом .
или )
.
Например, следующая разметка:
1. Первый пункт
1. Второй пункт
1. Третий пункт
будет отображаться так:
- Первый пункт
- Второй пункт
- Третий пункт
Вложенный упорядоченный список
Чтобы оформить вложенный упорядоченный список, добавьте отступ в начале строк с элементами вложенного списка. Допустимый размер отступа — от трех до шести пробелов.
Например, следующая разметка:
1. Первый пункт
1. Вложенный пункт
1. Вложенный пункт
1. Второй пункт
будет отображаться так:
-
Первый пункт
1.1. Вложенный пункт
1.2. Вложенный пункт -
Второй пункт
Таблицы
Таблица состоит из одной строки с заголовками, разделительной строки и строк с данными.
Каждая строка таблицы состоит из ячеек, отделенных друг от друга символами |
.
В ячейках разделительной строки используются только символ -
и символ :
. Символ :
ставится в начале, в конце или с обеих сторон содержимого ячейки разделительной строки, чтобы обозначить выравнивания текста в соответствующем столбце по левой стороне, по правой стороне или по центру соответственно.
Таблицу нужно отделять от предшествующего и последующего текста пустыми строками.
Например, следующая разметка:
По левому краю | По правому краю | По центру
:--- | ---: | :---:
Текст | Текст | Текст
будет отображаться так:
По левому краю | По правому краю | По центру |
---|---|---|
Текст | Текст | Текст |
Если необходимо добавить в ячейку таблицы перенос строки или более сложный элемент (например, список или блок кода), воспользуйтесь альтернативной разметкой:
#|
|| **Заголовок1** | **Заголовок2** ||
|| Текст | Текст ||
|#
Пример разметки с переносами и списком:
#|
||Текст
на двух строчках
|
- Пункт 1
- Пункт 2
- Пункт 3
- Пункт 4||
|#
См. подробнее в документации YFM
Ссылки
С помощью ссылок вы можете указать информацию, которые имеет отношение к дашборду или чартам.
Например, добавить ссылки на другие дашборды, указать источники данных.
Ссылка состоит из двух частей:
[текст]
— текст ссылки.(ссылка)
— URL или путь до файла, на который делается ссылка.
Например, следующая разметка:
[ссылка на yandex.ru](https://yandex.ru).
будет отображаться так:
Оформление кода
Фрагмент кода можно оформить как часть предложения или как отдельный блок.
Фрагмент кода как часть предложения
Чтобы оформить фрагмент кода как часть предложения, используйте символ `
.
Например, следующая разметка:
Предложение с `фрагментом кода`.
будет отображаться так:
Предложение с фрагментом кода
.
Фрагмент кода отдельным блоком
Чтобы оформить фрагмент кода как отдельный блок, используйте утроенный символ `
и имя соответствующего языка программирования.
Например, следующая разметка:
```kotlin
val a: Int = 1
```
будет отображаться как фрагмент кода на языке Kotlin с подсветкой:
val a: Int = 1
Изображение
Допускается добавление изображений с доменов *.yandex.ru
, *.yandex.net
, yastat.net
, yastatic.net
или storage.yandexcloud.net
. Самый простой способ — загрузить и опубликовать изображение в Yandex Object Storage. Сервис бесплатен, если у вас не больше 1 ГБ хранения в стандартном хранилище в месяц.
Поддерживается добавление изображений любого формата.
Для загрузки изображения из Object Storage в виджет:
-
Откройте консоль управления
. -
В левом верхнем углу нажмите значок
и выберите сервис Object Storage. -
Создайте бакет с публичным доступом.
-
Загрузите изображение в бакет.
-
Перейдите в полученный объект и нажмите кнопку Получить ссылку.
-
Скопируйте ссылку на изображение.
Примечание
Поддерживаются только ссылки на объекты вида
https://storage.yandexcloud.net/<bucket>/<key>
. -
Перейдите в ваш дашборд сервиса DataLens и создайте виджет Текст.
-
Вставьте в виджет следующий код:
![alt text](https://ссылка_на_изображение "Текст для подсказки при наведении" =100x200)
Каты
Используйте каты, чтобы скрыть часть контента. Например, дополнительную информацию или длинные блоки кода.
Например, следующая разметка:
{% cut "Заголовок ката" %}
Контент, который отобразится по нажатию.
{% endcut %}
будет отображаться так:
Контент, который отобразится по нажатию.
Всплывающие подсказки
Всплывающие подсказки позволяют при нажатии на термине отображать связанное с ним по ключу термина определение.
Пример разметки:
[*term_key]: Определение термина, которое может включать в себя _базовую_ разметку:
* списки;
* ссылки;
* картинки и т.д.
Использование [термина](*term_key) в тексте.
Примечание
На данный момент использование всплывающих подсказок в блоках кода возможно, только если у блока кода не указан язык.