Making call outs in GitHub markdown docs
Examples of how to add call outs to GitHub markdown docs
Published:
I like to decorate my PRs with notes and warnings. GitHub supports this with special styling. I can never remember the markdown syntax for it, so here’s a post.
> [!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.They render like this
Written by Jay Wilson on