⚠️ GitHub Alerts
Dr. Jekyll supports GitHub-style alert blocks, which allow you to create visually distinct sections in your documentation to highlight important information, tips, warnings, and more. These alert blocks are rendered with specific styles that make them stand out, helping users quickly identify critical content. For more information, you can see the GitHub Admonitions documentation for details on how to use and customize these alerts in your Dr. Jekyll documentation.
Table of Contents
Supported Alert Types
| Type | Markdown |
|---|---|
| NOTE | > [!NOTE] |
| TIP | > [!TIP] |
| IMPORTANT | > [!IMPORTANT] |
| WARNING | > [!WARNING] |
| CAUTION | > [!CAUTION] |
Usage
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> And supports multi-line text.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
> [!CAUTION]
> Negative potential consequences of an action.
Note
Highlights information that users should take into account, even when skimming. And supports multi-line text.
Tip
Optional information to help a user be more successful.
Important
Crucial information necessary for users to succeed.
Warning
Critical content demanding immediate user attention due to potential risks.
Caution
Negative potential consequences of an action.