向页面添加注释时,请始终使用此特殊的注释格式。有三种类型的格式化注释:note、caution 和 tip。
这里有一些关于注释的附加信息:
- 注释的颜色取决于注释的类型:
note是蓝色,caution是黄色,tip是紫色。 - 对于每种注释类型,标题文本都是可选的。
- 所有注释类型都可以包含文本以及其他格式(如列表、代码块和图像)。
要了解注释如何契合我们的内容策略,请参阅注释/提示/警告。
对于微小的补充内容,或者当您需要提供对主要内容并非必不可少的额外上下文时,使用注释 (Note)。
如果您不提供标题,此旁注将默认显示为 Note。
:::note[Header]
Hello, world!
:::使用注意 (Caution) 来突出可能会给用户带来问题的操作。
如果您不提供标题,此旁注将默认显示为 Warning。
:::caution[Feature conflict]
If you use feature A and feature B together, your configuration will not work.
:::使用提示 (Tip) 来分享不适合放入主要文档的最佳实践或具有倾向性的用例。
如果您不提供标题,此旁注将默认显示为 Tip。
:::tip[Best practice]
Cloudflare recommends you use [1.1.1.1](/1.1.1.1/) as your DNS resolver.
:::