Skip to content

Instantly share code, notes, and snippets.

@ryanlewis
Last active March 25, 2026 10:18
Show Gist options
  • Select an option

  • Save ryanlewis/911f6a4df8f042d857cbac4374bd4fdc to your computer and use it in GitHub Desktop.

Select an option

Save ryanlewis/911f6a4df8f042d857cbac4374bd4fdc to your computer and use it in GitHub Desktop.

Callout Rendering Comparison

GitHub-native alerts — no titles

Note

No title — baseline.

Tip

No title — baseline.

Important

No title — baseline.

Warning

No title — baseline.

Caution

No title — baseline.


GitHub-native alerts — with titles (lowercase)

[!note] Custom note title Lowercase type with a custom title.

[!tip] Pro tip Lowercase type with a custom title.

[!important] Read this first Lowercase type with a custom title.

[!warning] Freshness warning Lowercase type with a custom title.

[!caution] Breaking change Lowercase type with a custom title.


GitHub-native alerts — with titles (uppercase)

[!NOTE] Custom note title Uppercase type with a custom title.

[!TIP] Pro tip Uppercase type with a custom title.

[!IMPORTANT] Read this first Uppercase type with a custom title.

[!WARNING] Freshness warning Uppercase type with a custom title.

[!CAUTION] Breaking change Uppercase type with a custom title.


Obsidian-only callouts

[!info] Contextual information Obsidian-only type.

[!done] Completed 5 Mar 2026 Obsidian-only type.

[!success] Validation passed Obsidian-only type.

[!todo] Action required (human) Obsidian-only type.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment