Using GitHub Alerts and Obsidian Callouts

These examples will show you how to enhance your documents with structured callouts or alerts to highlight cautionary notes, important tips, and other information effectively.

GitHub Alerts

GitHub flavored markdown supports special alert syntax, using blockquotes combined with special syntax to simulate an alert box.

Below are examples you can use:

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!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.

Obsidian Callouts

Obsidian supports enhanced callouts which can be used directly by using a syntax very similar to GitHub Alerts. The primary difference is Obsidian uses lowercase and supports additional types beyond the five supported by GitHub.

Here are some examples:

> [!info]
> Lorem ipsum dolor sit amet

> [!todo]
> Lorem ipsum dolor sit amet

> [!example]
> Lorem ipsum dolor sit amet

See the Obsidian Help: Callout Types page for more examples.

Conclusion

By incorporating these alert and callout formats in your Markdown documents, you can make your content more engaging and easier to navigate. This structured approach will assist your readers in quickly identifying key information, thereby improving their learning experience.

See Also

GitHub Markdown: Alerts

Obsidian Help: Callouts

Obsidian Help: Callout Types