提示框语法(纯Markdown)
提示框语法(纯Markdown)
本文将教你如何在Markdown(.md)文件里使用GitHub风格的提示引用块语法。
备注: 如果你使用MDX文件,请查看提示框组件(MDX),该文档使用Astro自定义组件写法。
基础用法
通过特殊格式的引用块,即可生成各类提示框。
备注
NOTE
这是备注提示框,适合放置辅助补充类信息,方便读者参考。
提示
TIP
这是提示框,用来分享实用技巧、推荐方案。
重点
IMPORTANT
这是重点提示,用于需要读者着重留意的关键内容。
警告
WARNING
这是警告提示,提醒用户需要留意潜在问题。
注意风险
CAUTION
这是风险提示,用来告知存在隐患、负面后果的内容。
多行内容提示框
提示框内支持多段落与各类Markdown格式。
NOTE
这是备注的第一段文字,用来提供基础说明信息。
这是第二段内容,提示框可以分段书写,用于展开详细解释。
同时支持加粗、斜体以及行内代码样式。
提示框内嵌套列表
提示框中可有序、无序列表等Markdown元素。
TIP
几条使用规范:
- 提示内容尽量简洁精炼
- 根据内容选择匹配的提示类型
- 不要在单个提示框堆砌大量文字
无序列表示例:
- 功能一
- 功能二
- 功能三
使用方式
在任意Markdown文件中使用以下格式:
> [!NOTE]
> 这里填写提示内容。