上下文菜单

为你的文档添加一键 AI 集成

上下文菜单可快速访问经过 AI 优化的内容，并直接集成主流 AI 工具。用户在任意页面打开上下文菜单时，可以将内容复制为 AI 工具的上下文，或在 ChatGPT、Claude、Perplexity，或你自定义的工具中发起对话，并自动以你的文档作为上下文加载。

菜单选项

上下文菜单包含多个内置选项，你可以在配置中添加其标识符来启用。

选项	标识符	描述
复制页面	copy	将当前页面复制为 Markdown，便于粘贴到 AI 工具作为上下文
以 Markdown 查看	view	以 Markdown 打开当前页面
在 ChatGPT 中打开	chatgpt	以当前页面为上下文创建一段 ChatGPT 对话
在 Claude 中打开	claude	以当前页面为上下文创建一段 Claude 对话
在 Perplexity 中打开	perplexity	以当前页面为上下文创建一段 Perplexity 对话
复制 MCP 服务器 URL	mcp	将你的 MCP 服务器 URL 复制到剪贴板
连接到 Cursor	cursor	在 Cursor 中安装你托管的 MCP 服务器
连接到 VS Code	vscode	在 VS Code 中安装你托管的 MCP 服务器

启用上下文菜单

在你的 docs.json 文件中添加 contextual 字段，并指定要包含的选项。

{
 "contextual": {
   "options": [
     "copy",
     "view",
     "chatgpt",
     "claude",
     "perplexity",
     "mcp",
     "cursor",
     "vscode"
   ]
 }
}

添加自定义选项

通过在 options 数组中添加一个对象，在上下文菜单中创建自定义选项。每个自定义选项需要以下属性：

title · string · required

选项的标题。

description · string · required

选项的描述。展开上下文菜单时显示在标题下方。

icon · string · required

要显示的图标。

可选值：

• Font Awesome 图标 的名称
• Lucide 图标 的名称
• 用花括号包裹的、与 JSX 兼容的 SVG 代码
• 指向外部托管图标的 URL
• 项目中图标文件的路径

对于自定义 SVG 图标：

1. 使用 SVGR 转换器将 SVG 进行转换。
2. 将转换后的 SVG 代码粘贴到 SVG 输入框中。
3. 从 JSX 输出框复制完整的 <svg>...</svg> 元素。
4. 将与 JSX 兼容的 SVG 代码用花括号包裹：icon={<svg ...> ... </svg>}。
5. 按需调整 height 和 width。

iconType · string

Font Awesome 的图标样式。仅在使用 Font Awesome 图标时生效。

可选值：regular、solid、light、thin、sharp-solid、duotone、brands。

href · string | object · required

选项的 href。简单链接使用字符串，带查询参数的动态链接使用对象。

Show href 对象

base · string · required

该选项的基础 URL。

query · object · required

该选项的查询参数。

Show query 对象

key · string · required

查询参数键。

value · string · required

查询参数值。我们会将以下占位符替换为对应的值：

• 使用 $page 插入当前页面的 Markdown 内容。
• 使用 $path 插入当前页面路径。
• 使用 $mcp 插入托管的 MCP 服务器 URL。

自定义选项示例：

{
    "contextual": {
        "options": [
            "copy",
            "view",
            "chatgpt",
            "claude",
            "perplexity",
            {
                "title": "Request a feature",
                "description": "Join the discussion on GitHub to request a new feature",
                "icon": "plus",
                "href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests"
            }
        ]
    }
}

自定义选项示例

简单链接

{
  "title": "请求新功能",
  "description": "在 GitHub 上参与讨论",
  "icon": "plus",
  "href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests"
}

包含页面内容的动态链接

{
  "title": "在 X 上分享",
  "description": "在 X 上分享此页面",
  "icon": "x",
  "href": {
    "base": "https://x.com/intent/tweet",
    "query": [
      {
      "key": "text",
      "value": "查看这篇文档：$page"
      }
    ]
  }
}