Notes
A note is a highlighted block with important information.
Depending on the content, notes with different headings and formatting are used:
- "Note" — additional information.
- "Tip" — a recommendation.
- "Important" — a caution.
- "Alert" — a restriction.
- A note with a custom heading.
Notes can include any YFM markup, but it is not recommended to overload them with elements. Choose simple formatting and do not use notes too often, as this will distract the user from the main content.
Warning
The construct works only if it is separated by blank lines — outside (before the opening and after the closing tag) and inside (between the tags and the content). Otherwise, it will not be processed and will remain plain text.
Note
{% note info %}
Это примечание.
{% endnote %}
Result:
Note
This is a note.
Tip
{% note tip %}
Это совет.
{% endnote %}
Result:
Tip
This is a tip.
Important
{% note warning %}
Это важная информация.
{% endnote %}
Result:
Warning
This is important information.
Alert
{% note alert %}
Это предупреждение.
{% endnote %}
Result:
Alert
This is a warning.
Custom heading
{% note info "Свой заголовок" %}
Это заметка со своим заголовком.
{% endnote %}
Result:
Custom heading
This is a note with a custom heading.
{% note info "" %}
Это заметка без заголовка.
{% endnote %}
Result:
This is a note without a heading.