这篇文章专门测试 Admonition。每个小节先给 Markdown 用法,再给实际渲染效果。

Note

用法:

md
> [!NOTE]
>
> 这是一个没有标题的普通提示块。
>

效果(标题固定是类型名「注意」):

注意

这是一个没有标题的普通提示块。

同行文字算正文(GitHub 语义)

用法:

md
> [!WARNING] 本文写于 2016 年,操作可能已过时,仅供参考。

效果(标题仍是「警告」,那句话在正文框里 —— 2026-10 之前它会被当成标题、正文框是空的):

警告

本文写于 2016 年,操作可能已过时,仅供参考。

想要小标题:正文首行加粗

用法:

md
> [!TIP]
> **性能优化建议**
>
> 用 `Promise.all()` 并行跑异步任务。

效果:

技巧

性能优化建议

用 Promise.all() 并行跑异步任务。

Info

用法:

md
> [!INFO]
>
> 这里适合放补充信息。
>

效果:

信息

这里适合放补充信息。

Tip

用法:

md
> [!TIP]
>
> 适合放操作建议、经验提示或推荐做法。
>

效果:

技巧

适合放操作建议、经验提示或推荐做法。

Warning

用法:

md
> [!WARNING]
>
> 这里放需要特别留意的内容。
>

效果:

警告

这里放需要特别留意的内容。

Question

用法:

md
> [!QUESTION]
>
> 这里可以放待确认的问题。
>

效果:

问题

这里可以放待确认的问题。

Quote

用法:

md
> [!QUOTE]
>
> 这里可以放引用、摘录或补充说明。
>

效果:

引用

这里可以放引用、摘录或补充说明。

Abstract

用法:

md
> [!ABSTRACT]
>
> 这里可以放一段文章摘要或结论。
>

效果:

摘要

这里可以放一段文章摘要或结论。

新增类型(FixIt 扩展)

Success

成功

操作成功,一切正常。

Failure

失败

操作失败,请重试。

Danger

危险

危险操作,请勿模仿。

Bug

Bug

已知缺陷记录。

Example

示例

一个具体例子。

Todo

待办

待办事项列表。

GitHub 别名

信息

IMPORTANT 别名映射到 INFO。

GitHub 还提供了 CAUTION 别名:

警告

CAUTION 别名映射到 WARNING。

可折叠

点击任意标题栏即可折叠/展开内容(默认展开)。