001-markdown提示框语法

在写markdown时,有时会想要嵌套一些提示或者注意事项,这时候就需要用到提示框语法了。

GFM(GitHub Flavored Markdown)提示框语法

参考链接:GFM - Alter

示例

+ 提示框

这是提示框的内容

这是警告框的内容

代码:

> [!TIP]+ 提示框
>
> 这是提示框的内容
> > [!WARNING]
> > 这是警告框的内容

语法解析

[!TIP]表示接下来的引用块为tips内容,后面紧接着的+表示这是一个可折叠的提示框,且默认展开。+接一个空格后的文本就是提示框的标题,可以看到,在warning框中省略标题后就会显示默认的标题。可以看到,提示框是可以嵌套的,只需要在引用快中嵌套一层引用块即可。以下为可用的提示框:

NOTE

+ 提示框

这是提示框的内容

TIP

+ 提示框

这是提示框的内容

WARNING

+ 警告框

这是警告框的内容

IMPORTANT

+ 重要提示框

这是重要提示框的内容

CAUTION

+ 失败提示框

这是失败提示框的内容

总结

类型 (Type)语法 (Syntax)主要用途
注意 (Note)> [!NOTE]提供需要用户留意的一般性信息
提示 (Tip)> [!TIP]提供辅助用户更好地达成目标的建议
重要 (Important)> [!IMPORTANT]强调对用户达成目标至关重要的关键信息
警告 (Warning)> [!WARNING]提示需要用户立即关注的紧急信息,以避免问题
小心 (Caution)> [!CAUTION]提醒用户某些操作可能带来的风险或负面后果