---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://3y3.dev/en/syntax/notes.md
  - https://3y3.dev/ru/syntax/notes.md
  - href: en/syntax/notes.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
updatedAt: '2026-06-08T16:57:28.000Z'
---
> **Documentation Index:** Fetch the complete configuration index at https://3y3.dev/en/llms.txt

# Notes

A note is a highlighted block that contains important information.

Depending on the content, notes with different titles and formatting are used:

* Note: Additional information.
* Advice: A recommendation.
* Important: A warning.
* Attention: A restriction.
* A note with its own header.

Notes can include any YFM markup, but we don't recommend overloading them with elements. Choose a simple design and don't overuse notes because this will distract the user from the main content.

<!-- source: en/_includes/blank-lines-note.md -->
{% note warning %}

A construction works only when it is separated by empty lines — outside (before the opening tag and after the closing one) and inside (between the tags and the content). Otherwise it won't render and will stay as plain text.

{% endnote %}
<!-- endsource: en/_includes/blank-lines-note.md -->

## Comment

```markdown
{% note info %}

This is info.

{% endnote %}
```

**Result**

{% note info %}

This is info.

{% endnote %}

## Tip

```markdown
{% note tip %}

This is a tip.

{% endnote %}
```

**Result**

{% note tip %}

This is a tip.

{% endnote %}

## Warning

```markdown
{% note warning %}

This is a warning.

{% endnote %}
```

**Result**

{% note warning %}

This is a warning.

{% endnote %}

## Alert

```markdown
{% note alert %}

This is an alert.

{% endnote %}
```

**Result**

{% note alert %}

This is an alert.

{% endnote %}

## Custom header

```markdown
{% note info "Custom header" %}

This is a note with its own header.

{% endnote %}
```

**Result**

{% note info "Custom header" %}

This is a note with its own header.

{% endnote %}

```markdown
{% note info "" %}

This is a note without a header.

{% endnote %}
```

**Result**

{% note info "" %}

This is a note without a header.

{% endnote %}