# Callouts 提示框 Callouts（提示框）是 Doks 提供的一种特殊的内容块，用于突出显示重要信息、警告、提示或其他需要引起读者注意的内容。通过使用 Callouts，你可以更有效地传达关键信息，增强文档的可读性和用户体验。 ## Callouts 的使用方法 在 Doks 中，你可以使用以下语法来创建 Callouts： ```markdown {{}} 这是一个普通信息框。 {{}} ``` {{< callout context="note" title="Note" icon="outline/notebook" >}} 这是一个普通信息框。 {{< /callout >}} --- ```markdown {{}} 这是一个提示框。 {{}} ``` {{< callout context="tip" title="Tip" icon="outline/image-generation" >}} 这是一个提示框。 {{< /callout >}} --- ```markdown {{}} 这是一个警告框。 {{}} ``` {{< callout context="caution" title="Caution" icon="outline/alert-triangle" >}} 这是一个警告框。 {{< /callout >}} --- ```markdown {{}} 这是一个危险框。 {{}} ``` {{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}} 这是一个危险框。 {{< /callout >}} 在上面的示例中，我们创建了一个 Callout，指定了 `context`（上下文）为 "tip"，`title`（标题）为 "Tip"，以及一个图标。你可以根据需要调整这些参数来创建不同类型的 Callouts。 ## Callouts 的上下文类型 Doks 支持多种上下文类型，每种类型都有不同的样式和用途。常见的上下文类型包括： - `tip`: 用于提供有用的提示或建议。 - `note`: 用于提供一般信息或背景知识。 - `caution`: 用于提供警告信息，提醒读者注意潜在的风险或问题。 - `danger`: 用于提供严重的警告信息，强调重要的安全风险或错误。 通过选择适当的上下文类型，你可以更有效地传达信息的性质和重要性，帮助读者更好地理解和关注内容。 ## Callouts 的图标选择 Doks 允许你为 Callouts 添加图标，以增强视觉效果和信息传达。你可以使用 [Tabler Icons](https://tabler.io/icons) 中的图标，选择适合你内容的图标，并在 Callout 中指定。例如： ```markdown {{}} 这是一个提示框。 {{}} ``` {{< callout context="tip" title="Tip" icon="outline/comet" >}} 这是一个提示框。 {{< /callout >}} ## Callouts 的最佳实践 - **明确标题**：为每个 Callout 提供一个清晰的标题，以帮助读者快速理解内容的主题。 - **选择合适的上下文**：根据内容的性质选择适当的上下文类型，以确保信息的传达效果。 - **使用图标增强视觉效果**：合理使用图标可以帮助读者更快地识别信息的类型和重要性，但不要过度使用，以免造成视觉混乱。 - **保持内容简洁**：Callouts 应该包含简洁明了的信息，避免过多的细节，以确保读者能够快速获取关键信息。 通过遵循这些最佳实践，你可以有效地利用 Callouts 来增强文档的可读性和用户体验，帮助读者更好地理解和关注重要信息。