Prompt

<Prompt> 组件将一组可复用的指令转换为一张卡片，读者可以复制它，或在受支持的 AI 工具中打开。复制和打开操作使用标签之间人类可见的确切编写内容。

基本用法

每个 Prompt 都有一个复制操作。最简单的版本无需任何属性：

Explain how API key rotation works for a developer using our REST API for the first time.

<Prompt>

Explain how API key rotation works for a developer using our REST API for the first time.

</Prompt>

标题和描述

使用 title 为任务添加标签。与 Mintlify 兼容的 description 属性会用更简短的摘要替换可见预览。复制和打开操作仍然使用标签之间的完整人类可见内容。

Write a release note for the new API key rotation endpoint.

- Address backend developers.
- Lead with the user benefit.
- Include one request example.

<Prompt
  title="Draft a release note"
  description="Write a concise release note for a developer audience."
  actions={["copy", "claude"]}
>
Write a release note for the new API key rotation endpoint.

- Address backend developers.
- Lead with the user benefit.
- Include one request example.

</Prompt>

复制操作始终存在。为兼容起见，接受显式的 "copy" 操作，但通常不需要。

打开操作

添加 claude、cursor、chatgpt、perplexity 或 gemini，让读者在这些工具中打开提示词。每个操作都会显示其品牌图标。第一个有效的打开操作显示在复制按钮旁边，其余的显示在“更多”菜单中。

Compare the session-token and API-key authentication flows in this repository. List their security tradeoffs and recommend which flow each client type should use.

<Prompt
  title="Compare authentication flows"
  actions={["claude", "cursor", "chatgpt", "perplexity", "gemini"]}
>
Compare the session-token and API-key authentication flows in this repository.
List their security tradeoffs and recommend which flow each client type should use.

</Prompt>

自定义 URL 操作

自定义操作接受 label、HTTPS 或 HTTP 的 url，以及可选的图标。将 {prompt} 放在路径段、查询值或片段中，以控制 URL 编码后的提示词放置位置。如果省略占位符，Jamdesk 会添加 prompt 查询参数。

Compare this migration plan with the current public API contract. Identify breaking changes, missing rollback steps, and tests needed before release.

<Prompt
  title="Research this migration"
  actions={[
    {
      label: "Search the web",
      url: "https://www.google.com/search?q={prompt}",
      icon: "magnifying-glass",
    },
    "claude",
  ]}
>
Compare this migration plan with the current public API contract. Identify
breaking changes, missing rollback steps, and tests needed before release.

</Prompt>

自定义操作的 URL 必须是不含凭据的 http: 或 https: URL。Jamdesk 会拒绝其他协议、源或查询键中的占位符，以及长度超过 8,000 个字符的最终操作 URL。当某个打开操作被拒绝时，复制功能仍然可用。

自定义图标

将 icon 设置为 Font Awesome 名称、图片 URL 或路径，或内联 SVG。使用 iconType 为不带前缀的 Font Awesome 名称选择样式。

Outline a hands-on tutorial that gets a new user from installation to a successful API request in under ten minutes.

<Prompt title="Plan a tutorial" icon="pen-nib" iconType="duotone">

  Outline a hands-on tutorial that gets a new user from installation to a
  successful API request in under ten minutes.

</Prompt>

有关可用名称和样式，请参阅 图标。

紧凑显示

预览最多显示三行，较长的提示词会可滚动。展开控件会打开完整提示词。设置 singleLine 可将预览裁剪为一行。复制和打开操作仍然使用完整的人类可见提示词。

Summarize the public API in five bullets:

- Authentication and token lifetimes.
- Pagination conventions.
- Rate limits and retry guidance.
- Error format and common codes.
- Versioning and deprecation policy.

当仅标签就足以为读者提供上下文时，可将 hidePrompt 与 title 一起使用：

Create a migration checklist for moving from API v1 to v2. Include prerequisites, code changes, validation steps, rollback criteria, and owner sign-off.

<Prompt title="Summarize the API">

  Summarize the public API in five bullets:

  - Authentication and token lifetimes.
  - Pagination conventions.
  - Rate limits and retry guidance.
  - Error format and common codes.
  - Versioning and deprecation policy.

</Prompt>

<Prompt title="Generate a migration checklist" hidePrompt actions={["claude"]}>

  Create a migration checklist for moving from API v1 to v2. Include
  prerequisites, code changes, validation steps, and rollback criteria.

</Prompt>

只有设置了 title 时，hidePrompt 才会隐藏预览。没有 title 时，提示词保持可见。

属性

接下来做什么？