GFM 提示框
GitHub 风格提示框,内容更醒目
功能演示图 / GIF
(此处可放置功能截图或演示 GIF)什么是GFM 提示框?
GFM(GitHub Flavored Markdown)提示框是一种特殊的 Markdown 语法,用于创建醒目的提示信息。Yipoo 支持 6 种类型:NOTE(说明)、TIP(提示)、IMPORTANT(重要)、WARNING(警告)、CAUTION(注意)、INFO(信息)。每种类型都有独特的图标和颜色,让重要信息更突出。
为什么要使用?
在文章中,总有一些信息需要特别强调,比如注意事项、实用技巧、重要警告等。传统的加粗或斜体往往不够醒目,而提示框能让这些信息立即吸引读者注意。Yipoo 的提示框样式优雅,完美兼容微信公众号,复制后样式完整保留。
如何使用?
- 1使用 `> [!NOTE]` 语法创建提示框
- 2在下一行继续使用 `>` 写入提示内容
- 3支持 6 种类型:NOTE、TIP、IMPORTANT、WARNING、CAUTION、INFO
- 4示例: ``` > [!TIP] > 这是一个实用技巧 ```
- 5提示框内可以使用其他 Markdown 语法(加粗、链接等)
- 6提示框会自动显示对应的图标和颜色
最佳实践
- NOTE 适合补充说明,TIP 适合实用技巧
- WARNING 和 CAUTION 用于重要警告,不要滥用
- IMPORTANT 用于强调关键信息
- 提示框内容要简洁,避免过长
- 一篇文章中不要使用过多提示框,保持克制
- 提示框前后留白,让视觉更舒适