Заметки
Заметка — это выделяющийся блок с важной информацией.
В зависимости от содержания используют заметки с различными заголовками и оформлением:
- «Примечание» — дополнительная информация.
- «Совет» — рекомендация.
- «Важно» — предостережение.
- «Внимание» — ограничение.
- Заметка со своим заголовком.
Заметки могут включать любую разметку YFM, но не рекомендуется перегружать их элементами. Выбирайте простое оформление и не используйте заметки слишком часто, так как это будет отвлекать пользователя от основного содержимого.
Примечание
{% note info %}
Это примечание.
{% endnote %}
Результат:
Примечание
Это примечание.
Совет
{% note tip %}
Это совет.
{% endnote %}
Результат:
Совет
Это совет.
Важно
{% note warning %}
Это важная информация.
{% endnote %}
Результат:
Важно
Это важная информация.
Внимание
{% note alert %}
Это предупреждение.
{% endnote %}
Результат:
Внимание
Это предупреждение.
Свой заголовок
{% note info "Свой заголовок" %}
Это заметка со своим заголовком.
{% endnote %}
Результат:
Свой заголовок
Это заметка со своим заголовком.
{% note info "" %}
Это заметка без заголовка.
{% endnote %}
Результат:
Это заметка без заголовка.
Была ли статья полезна?
Предыдущая
Следующая