Синтаксис YFM
Yandex Flavored Markdown (YFM) — это диалект Markdown с дополнительным набором инструментов. Он используется для разметки текста в Tracker.
На этой странице кратко описаны основные элементы, больше информации вы можете найти в Справочнике разметки Wiki
Примечание
Разметку любого элемента можно добавить командой /
в режиме «Визуальный редактор (wysiwyg)» или кнопкой на панели инструментов в режиме «Разметка Markdown».
Форматирование текста
Разметка |
Результат |
|
Курсив |
|
Полужирный текст |
|
Подчеркнутый текст |
|
|
|
##Моноширинный текст## |
|
Выделенный текст |
Поддерживаемые цвета:
|
Цветной текст |
|
Верхнийиндекс |
При форматировании текста вы можете комбинировать элементы разметки в любом порядке:
**_Оформление текста 1_** и **_Оформление текста 2_**
{orange}(~~Зачеркнутая часть~~ оранжевого текста)
Результат
Оформление текста 1 и Оформление текста 2
Зачеркнутая часть оранжевого текста
Заголовки
Заголовки могут быть нескольких уровней. Чем выше уровень заголовка, тем крупнее шрифт. Для оформления заголовков используйте символы #
.
# Заголовок первого уровня
#### Заголовок четвертого уровня
###### Заголовок шестого уровня
Результат
Заголовок первого уровня
Заголовок четвертого уровня
Заголовок шестого уровня
Ссылки
-
Чтобы добавить текст со ссылкой, используйте разметку:
[Главная страница Яндекса](https://ya.ru/)
Результат
-
URL-адрес без разметки автоматически преобразуется в ссылку:
https://ya.ru/
Результат
Изображение
Для вставки изображения используйте разметку:
![alt-текст](https://exmple.com/image.png "текст подсказки" =100x100)
Параметры разметки
-
alt-текст
— Альтернативный текст. Текст будет отображаться, если не удастся загрузить изображение. Необязательный параметр. -
https://exmple.com/image.png
— Ссылка на изображение. Чтобы добавить в текст изображение, прикрепленное к комментарию или описанию задачи, скопируйте его URL с помощью значка . -
"текст подсказки"
— Подсказка, которая будет отображаться при наведении указателя на изображение. Необязательный параметр. -
=100x100
— Размер изображения в пикселях. Необязательный параметр.
Чтобы сохранить исходное соотношение сторон изображения, укажите только его ширину в формате:=100x
.
Цитаты
Для отображения цитаты используйте символ >
.
Чтобы оформить вложенную цитату, в начале абзаца вставьте символы >>
.
> Для отображения цитаты используйте специальный символ.
>>Чтобы оформить вложенную цитату, в начале абзаца вставьте два таких символа.
Результат
Для отображения цитаты используйте специальный символ.
Чтобы оформить вложенную цитату, в начале абзаца вставьте два таких символа.
Списки
Чтобы добавить список, используйте цифры и специальные символы:
- Нумерованный список.
Используйте цифры с символом.
или)
. Нумерация выполняется динамически, поэтому порядок цифр не важен. - Маркированный список.
Используйте символы*
,-
или+
. - Вложенный список.
Добавьте отступ от двух до пяти пробелов перед пунктами дочернего списка. В нумерованном списке можно использовать вложенный маркированный список и наоборот. - Контрольный список.
В качестве маркера используйте символы[ ]
. Между элементами списка должна быть пустая строка.
Чтобы отметить пункт списка флажком, вместо пробела добавьте между скобок символx
.
Пример |
Результат |
Нумерованный список |
|
|
|
Маркированный список |
|
|
|
Комбинированный список |
|
|
|
Контрольный список |
|
|
Дело 1 Дело 2 Дело 3 |
Фрагменты кода
-
Чтобы добавить фрагмент кода в текст в виде строки, используйте символ
`
. -
Чтобы оформить фрагмент кода как отдельный блок, отделите его символами
```
. Для подсветки синтаксиса укажите в начальной строке блока язык, на котором написан код. -
Внутри блока исходного кода все символы разметки автоматически экранируются. Чтобы отобразить символ
`
в обычном тексте, используйте экранирование.
Пример |
Результат |
Строка кода в тексте |
|
|
Код |
Блок кода |
|
|
|
Формулы
- Чтобы добавить формулу в строку текста, используйте символ
$
. - Чтобы отобразить формулу в отдельном блоке, отделите ее символами
$$
.
Пример |
Результат |
Строка с формулой |
|
|
Формула в тексте. |
Блок с формулой |
|
|
|
Экранирование
-
Чтобы символ разметки не был интерпретирован, его можно экранировать с помощью символа
\
:Верхний^индекс^ Верхний\^индекс^
Результат
Верхнийиндекс
Верхний^индекс^ -
Если нужно отобразить обратный апостроф внутри фрагмента исходного кода, окружите фрагмент кода двойными обратными апострофами
``
:``SELECT `id` FROM `table` ``
Результат
SELECT `id` FROM `table`
Разделители
Чтобы добавить разделитель между абзацами, вставьте три и более символов ---
с новой строки:
Конец абзаца
----
Следующий абзац
Таблицы
Простая таблица
В ячейках простых таблиц можно использовать только элементы строчного форматирования: оформление текста, изображения, ссылки.
| Заголовок1 | Заголовок2 |
| ----------- | ----------- |
| Текст | Текст |
| Текст | Текст |
Результат
Заголовок1 | Заголовок2 |
---|---|
Текст | Текст |
Текст | Текст |
Многострочная таблица
В ячейке многострочной таблицы можно размещать любой многострочный текст: списки, фрагменты кода, другие таблицы.
Многострочные таблицы не содержат заголовков, но вы можете применить форматирование к тексту в первой строке. Например, выделить его жирным начертанием.
#|
|| **Заголовок 1** | **Заголовок 2** ||
||Текст
на двух строчках
|
- Пункт 1
- Пункт 2
- Пункт 3
||
|#
Результат
Заголовок 1 |
Заголовок 2 |
Текст |
|
Примечания
Примечание — это выделяющийся блок с важной информацией.
{% note info "заголовок, можно оставить пустым" %}
В зависимости от содержания можно использовать другие заголовки, например «Совет», «Важно», «Внимание».
{% endnote %}
Результат
Примечание
В зависимости от содержания можно использовать другие заголовки, например «Совет», «Важно», «Внимание».
Каты
Кат — это скрытая часть текста или другой информации, которая появляется по нажатию.
{% cut "Заголовок ката" %}
Текст, который появится по нажатию на заголовок.
{% endcut %}
Результат
Это и есть пример ката.
Вкладки
Вкладки — это блоки текста, между которыми можно переключаться в горизонтальном меню.
{% list tabs %}
- Заголовок первой вкладки
Текст первой вкладки
- Заголовок второй вкладки
Текст второй вкладки
{% endlist %}
Результат
Текст первой вкладки
Текст второй вкладки