For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
预约演示登录免费开始
  • 入门
    • 概览
    • 工作原理
    • 快速开始
    • 项目结构
    • Customer showcase
    • 变更日志
  • 配置
    • 概览
    • 站点级设置
    • 页面级设置
  • 编写内容
    • Markdown 基础
    • Markdown 中的富媒体
      • 概览
      • 折叠面板
      • 旁注
      • 按钮
      • 徽章
      • 下载
      • 提示框
      • 卡片
      • 代码块
      • 复制组件
      • 下载组件
      • 端点请求片段
      • 端点响应片段
      • 端点模式代码片段
      • Webhook 负载片段
      • 文件
      • 框架
      • 图标
      • If
      • 缩进
      • 参数字段
      • 提示词组件
      • Runnable endpoint
      • 模式组件
      • 步骤
      • 表格
      • 标签页
      • 工具提示
      • 版本
    • Fern 编辑器
    • 可复用代码片段
  • AI 功能
    • 概览
    • Fern Writer
    • AI 生成的示例
    • Markdown 访问
      • 概览
      • Agent 指令
      • 智能体指令
      • 分析与集成
    • MCP 服务器
    • API 目录发现
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
预约演示登录免费开始
在本页
  • 使用方法
  • 变体
  • 意图类型
  • 自定义图标
  • 属性
编写内容组件

提示框

||以 Markdown 格式查看|
此页面是否有帮助?
在仪表板中编辑
上一个

按钮组件

下一个

卡片组件

<Callout> 组件用于在文档中突出显示重要信息、警告或提示。使用提示框来强调读者不应错过的关键细节,如破坏性更改、先决条件或有用的最佳实践。

要显示非常简短的信息(如状态指示器和版本号),请使用标记。

使用方法

这会在您的文档中添加一个注释。
Markdown
1<Note>这会在您的文档中添加一个注释。</Note>

变体

意图类型

这会引起对重要信息的注意
这会发出需要注意的警告
这表示成功的操作或积极的结果
这表示潜在错误
这突出显示额外的上下文或补充信息
这庆祝公告,使用文档站点的主要强调色样式
这建议一个有用的提示
这显示选中状态
Markdown
1<Info>这会引起对重要信息的注意</Info>
2<Warning>这会发出需要注意的警告</Warning>
3<Success>这表示成功的操作或积极的结果</Success>
4<Error>这表示潜在错误</Error>
5<Note>这突出显示额外的上下文或补充信息</Note>
6<Launch>这庆祝公告,使用文档站点的主要强调色样式</Launch>
7<Tip>这建议一个有用的提示</Tip>
8<Check>这显示选中状态</Check>

自定义图标

示例提示框

这个提示框使用了标题和自定义的 Font Awesome 图标。

Markdown
1<Warning title="示例提示框" icon="skull-crossbones">
2这个提示框使用了标题和自定义的 Font Awesome 图标。
3</Warning>

属性

intent
stringRequired

提示框的类型。可用选项:info、warning、success、error、note、launch、tip、check

title
string

提示框的标题

icon
string | ReactElement

提示框的图标。可以是:

  • Font Awesome 图标名称
  • React 元素
  • 如果未指定,将根据意图类型使用默认图标:
    • info:InfoCircle
    • warning:Bell
    • success:CheckCircle
    • error:WarningTriangle
    • note:Pin
    • launch:Rocket
    • tip:Star
    • check:Check
className
string

应用到提示框的额外 CSS 类