跳转至

GFM 支持admonitions

概要: 在GFM中使用醒目提示块

背景

在GitHub的Markdown语法变种GFM中,如果需要给出醒目的引用,如何实现类似于admonitions的效果?

image.png

语法

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

20240623171150-f5243-image.png

参考