提示框的语义类型与语法

• 本文约730字,阅读大致需要2分钟 • 指南

Chaos支持 GitHub风格的提示框语法,标题文字会随站点语言自动本地化,并配有对应的图标与边框色彩。除通用的五种类型外,主题还扩充了面向技术归档与免责声明的语义类型。

渲染效果

📓 注意

供浏览时参考的背景信息与补充说明。

💡 友情提示

有助于提高操作效率的使用技巧与建议。

❗ 重要

达成目标所必须了解的关键步骤或必要前提。

🚨 警告

需特别注意、以免引发错误或阻塞进度的警示。

⚠️ 小心

提醒某些破坏性操作可能带来的严重后果或数据丢失风险。

📜 历史文件已不具备现实意义

提示该文属于年代久远、技术方案已废弃或仅作归档参考的历史记录。

⚠️ 免责声明

声明作者不对依据本文内容操作导致的风险或意外后果承担连带责任。

📓 自定义标题示例

提示框亦支持自定义标题:在标记之后紧跟自定义文字,即可覆盖默认的本地化标题。

Markdown源码写法

只需在引用块(>)的第一行声明类型关键词:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
> [!NOTE]
> 供浏览时参考的背景信息与补充说明。

> [!TIP]
> 有助于提高操作效率的使用技巧与建议。

> [!IMPORTANT]
> 达成目标所必须了解的关键步骤或必要前提。

> [!WARNING]
> 需特别注意、以免引发错误或阻塞进度的警示。

> [!CAUTION]
> 提醒某些破坏性操作可能带来的严重后果或数据丢失风险。

> [!HISTORICAL]
> 提示该文属于年代久远、技术方案已废弃或仅作归档参考的历史记录。

> [!DISCLAIMER]
> 声明作者不对依据本文内容操作导致的风险或意外后果承担连带责任。

> [!NOTE] 自定义标题示例
> 在标记之后紧随标题文本,即可自定义提示框的头部说明。

💡 友情提示

多语言适配:不论在简体中文(zh-CN)、繁体中文(zh-TW)、英语(EN)、日语(JA)还是韩语(KO)页面下,默认标题均会自动渲染为对应的母语文字(如Note、注意、友情提示、歴史的ファイル 等),作者统一书写大写的英文关键词即可。