使用标注

使用标注来突出显示重要的补充内容,而不会打断文档流程

标注是吸引额外注意某些概念或更清晰地表明某些内容是补充性的或仅适用于某些场景的绝佳方式。

功能
创作
Author

Charles Teague

Published

Invalid Date

标注是吸引额外注意某些概念或更清晰地表明某些内容是补充性的或仅适用于某些场景的绝佳方式。

三个标注框:一个注释(带有蓝色横幅,信息图标位于标题前),一个提示(带有绿色横幅,灯泡图标位于标题前),和一个重要提示(带有红色横幅,信息感叹号图标位于标题前)。

标注基础

有五种不同类型的标注可供使用。

  • 注释
  • 提示
  • 重要
  • 注意
  • 警告

颜色和图标会根据您选择的类型而有所不同。

语法

使用以下语法在Markdown中创建标注(注意,标注中使用的第一个Markdown标题用作标注标题):

:::{.callout-note}
请注意,有五种标注类型,包括:
`note`, `tip`, `warning`, `caution`, 和 `important`
:::

:::{.callout-tip}
## 带标题的提示

这是一个带有标题的标注示例。
:::

请参阅我们的标注文档,了解更多信息,包括如何自定义标注的外观和行为。

Subscribe

Enjoy this blog? Get notified of new posts by email: