跳转至

提示框

提示框（也称为 callouts 或侧边栏）通过彩色方框和图标突出显示重要信息。

语法

!!! type "可选标题"
    内容写在这里。必须缩进。

类型

注释

!!! note
    这是一个注释提示框。

Note

这是一个注释提示框。

提示

!!! tip
    这是一个提示提示框。

Tip

这是一个提示提示框。

警告

!!! warning
    这是一个警告提示框。

Warning

这是一个警告提示框。

危险

!!! danger
    这是一个危险提示框。

Danger

这是一个危险提示框。

信息

!!! info
    这是一个信息提示框。

Info

这是一个信息提示框。

成功

!!! success
    这是一个成功提示框。

Success

这是一个成功提示框。

摘要

!!! abstract
    这是一个摘要提示框。

Abstract

这是一个摘要提示框。

可折叠提示框

添加 ? 使提示框可折叠：

??? note "点击展开"
    默认隐藏此内容。
点击展开

默认隐藏此内容。

添加 + 使其默认展开：

???+ note "已展开"
    默认显示此内容。
已展开

默认显示此内容。

自定义标题

!!! note "自定义标题"
    你可以替换默认的类型标签。

自定义标题

你可以替换默认的类型标签。

无图标

!!! note ""
    无图标，仅标题和内容。

无图标，仅标题和内容。

嵌套内容

提示框可以包含任何 Markdown 内容，包括代码块：

!!! example "配置示例"
    ``` yaml
    theme:
      palette:
        primary: teal
    ```

配置示例

theme:
  palette:
    primary: teal

所有提示框类型

类型颜色图标用于
note蓝色信息圆圈一般信息
abstract青色文档摘要、概要
info蓝色信息详细信息
tip绿色灯泡有用建议
success绿色对勾积极结果
question橙色帮助圆圈问题、FAQ
warning橙色警告三角形需要谨慎
failure红色X 圆圈某事失败
danger红色闪电关键警告
bug红色BugBug 报告
example紫色列表示例
quote灰色引号引用

下一步