> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-docs-automation-github-pr-review.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 提示

> 展示预置的 AI 提示，提供一键复制和 Cursor 集成按钮，方便用户在 AI 工具中快速使用。

使用 Prompt 组件来显示预构建的 AI 提示，用户可以将其复制到剪贴板，或直接在 [Cursor](https://www.cursor.com) 中打开。

<div id="examples">
  ## 示例
</div>

<Prompt description="生成清晰、简洁的说明。">
  你是一名**技术写作 AI 助手**。撰写清晰、准确且简洁的文档。

  * 使用第二人称（"you"）和主动语态动词。
  * 以目标导向的标题开始操作步骤。
  * 在写作前，先就文档的最终用户、他们的目标和需求提出澄清性问题。
</Prompt>

```mdx Basic prompt example theme={null}
<Prompt description="生成清晰、简洁的文档。">
你是一个**技术写作助手**。编写清晰、准确且简洁的文档。
- 使用第二人称("你")和主动动词。
- 以面向目标的标题开始操作步骤。
- 在编写之前,询问有关文档最终用户、他们的目标和需求的明确问题。
</Prompt>
```

<Prompt description="生成**清晰**、*简洁*的文档。" icon="paperclip" iconType="solid" actions={["copy", "cursor"]}>
  你是一名**技术写作助手**。请撰写清晰、准确且简洁的文档。

  * 使用第二人称（"you"）和主动语态。
  * 以目标导向的标题开始编写步骤。
  * 在动笔之前，先询问并澄清文档终端用户是谁、他们的目标是什么以及他们有哪些需求。
</Prompt>

```mdx Prompt with multiple properties example theme={null}
<Prompt
  description="Generate **clear**, *concise* documentation."
  icon="paperclip"
  iconType="solid"
  actions={["copy", "cursor"]}
>
你是一位**技术写作助手**。编写清晰、准确且简洁的文档。
- 使用第二人称（"你"）和主动语态动词。
- 以目标导向的标题开始操作步骤。
- 在编写之前,询问有关文档最终用户、他们的目标和需求的澄清性问题。
</Prompt>
```

<div id="properties">
  ## 属性
</div>

<ResponseField name="description" type="string" required>
  显示在提示卡片上的文本。支持 Markdown 格式。
</ResponseField>

<ResponseField name="children" type="string" required>
  提示的文本内容。此文本会被复制到剪贴板，或在 Cursor 中打开。
</ResponseField>

<ResponseField name="actions" type="array" default="[&#x22;copy&#x22;]">
  可用操作的数组。有效取值为 `"copy"`（复制到剪贴板）和 `"cursor"`（在 Cursor 中打开）。
</ResponseField>

<ResponseField name="icon" type="string">
  要显示的图标。

  可选值：

  * [Font Awesome](https://fontawesome.com/icons) 图标名称 (如果你在 `docs.json` 中将 `icons.library` [属性](/zh/organize/settings#param-icons) 设置为 `fontawesome`)
  * [Lucide](https://lucide.dev/icons) 图标名称 (如果你在 `docs.json` 中将 `icons.library` [属性](/zh/organize/settings#param-icons) 设置为 `lucide`)
  * [Tabler](https://tabler.io/icons) 图标名称 (如果你在 `docs.json` 中将 `icons.library` [属性](/zh/organize/settings#param-icons) 设置为 `tabler`)
  * 指向外部托管图标的 URL
  * 项目中图标文件的路径
  * 用花括号包裹的 SVG 代码

  对于自定义 SVG 图标：

  1. 使用 [SVGR 转换器](https://react-svgr.com/playground/) 转换你的 SVG。
  2. 将 SVG 代码粘贴到 SVG 输入框。
  3. 从 JSX 输出框中复制完整的 `<svg>...</svg>` 元素。
  4. 用花括号包裹可用于 JSX 的 SVG 代码：`icon={<svg ...> ... </svg>}`。
  5. 根据需要调整 `height` 和 `width`。
</ResponseField>

<ResponseField name="iconType" type="string">
  [Font Awesome](https://fontawesome.com/icons) 的图标样式。仅在使用 Font Awesome 图标时生效。

  可选值：`regular`、`solid`、`light`、`thin`、`sharp-solid`、`duotone`、`brands`。
</ResponseField>