Выноски

Выноски – рамочные блоки для текста, стоящего в стороне от основного изложения. Набор видов совпадает со словарём алертов GitHub, плюс нейтральный callout.

Виды

:::note
Тело заметки.
:::
Заметка

Заметка. Дополнительная информация, которую читатель может пропустить без потери нити.

Совет

Способ сделать что-то лучше.

Важно

Информация, необходимая для успеха.

Предупреждение
Предупреждение

То, что требует внимания перед продолжением.

Осторожно
Внимание

Действие с негативными последствиями.

Выноска

Нейтральная рамка для всего, чему нужно визуальное отделение.

Поведение

  • Название («Заметка», «Совет», ...) генерируется и переводится на язык публикации: в английской публикации будет Note, в немецкой – Hinweis. Своё название задать нельзя; если оно нужно, лучше подойдёт сворачиваемая секция или полужирное первое предложение.
  • Тело – полный Markdown: списки, формулы, код, ссылки.
  • Выноски – для голоса редактора, обращений к читателю. Для математической структуры (определения, замечания как результаты) есть утверждения; для цитирования источника – цитата.

Умеренные выноски направляют внимание. Страница, наполовину состоящая из выносок, выносок не имеет.