这篇文章专门测试 Admonition。每个小节先给 Markdown 用法,再给实际渲染效果。
Note 无标题
用法:
> [!NOTE]>> 这是一个没有标题的普通提示块。>效果:
注意
这是一个没有标题的普通提示块。
Note 带标题
用法:
> [!NOTE] 提示>> 这是一个普通提示块。>效果:
提示
这是一个普通提示块。
Info
用法:
> [!INFO] 信息>> 这里适合放补充信息。>效果:
信息
这里适合放补充信息。
Tip
用法:
> [!TIP] 建议>> 适合放操作建议、经验提示或推荐做法。>效果:
建议
适合放操作建议、经验提示或推荐做法。
Warning
用法:
> [!WARNING] 注意>> 这里放需要特别留意的内容。>效果:
注意
这里放需要特别留意的内容。
Question
用法:
> [!QUESTION] 问题>> 这里可以放待确认的问题。>效果:
问题
这里可以放待确认的问题。
Quote
用法:
> [!QUOTE] 引用>> 这里可以放引用、摘录或补充说明。>效果:
引用
这里可以放引用、摘录或补充说明。
Abstract
用法:
> [!ABSTRACT] 摘要>> 这里可以放一段文章摘要或结论。>效果:
摘要
这里可以放一段文章摘要或结论。
新增类型(FixIt 扩展)
Success
成功
操作成功,一切正常。
Failure
失败
操作失败,请重试。
Danger
危险
危险操作,请勿模仿。
Bug
Bug
已知缺陷记录。
Example
示例
一个具体例子。
Todo
待办
待办事项列表。
GitHub 别名
重要
IMPORTANT 别名映射到 INFO。
GitHub 还提供了 CAUTION 别名:
小心
CAUTION 别名映射到 WARNING。
可折叠
点击任意标题栏即可折叠/展开内容(默认展开)。
评论
GitHub 登录后可评论。
评论区会在滚动到这里时自动加载。