Выноски
Рамочные блоки — заметка, совет, важно, предупреждение, осторожно
Выноски — рамочные блоки для текста, стоящего в стороне от основного
изложения. Набор видов совпадает со словарём алертов GitHub, плюс
нейтральный callout.
Виды
Результат
Заметка
Дополнительная информация, которую читатель может пропустить без потери нити.
Совет
Способ сделать что-то лучше.
Важно
Информация, необходимая для успеха.
Предупреждение
То, что требует внимания перед продолжением.
Осторожно
Действие с негативными последствиями.
Выноска
Нейтральная рамка для всего, чему нужно визуальное отделение.
Markdown
:::note
Дополнительная информация, которую читатель может пропустить без потери нити.
:::
:::tip
Способ сделать что-то лучше.
:::
:::important
Информация, необходимая для успеха.
:::
:::warning
То, что требует внимания перед продолжением.
:::
:::caution
Действие с негативными последствиями.
:::
:::callout
Нейтральная рамка для всего, чему нужно визуальное отделение.
:::Поведение
- Название («Заметка», «Совет», ...) генерируется и переводится на язык публикации: в английской публикации будет Note, в немецкой – Hinweis.
- Своё название задаётся атрибутом
label::::warning{label="Перед развёртыванием"}. Текст выводится как написан (без перевода), вид рамки остаётся прежним.label=""убирает строку заголовка. - Тело — полный Markdown: списки, формулы, код, ссылки.
- Выноски — для голоса редактора, обращений к читателю. Для математической структуры (определения, замечания как результаты) есть утверждения; для цитирования источника – цитата.
Умеренные выноски направляют внимание. Страница, наполовину состоящая из выносок, выносок не имеет.