Skip to content
Mintlify
Mintlify
优化

上下文菜单

为你的文档添加上下文菜单,一键集成 ChatGPT、Claude、Perplexity、Google AI Studio、Devin、Devin Desktop 和 MCP 工具。

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

将上下文菜单与你托管的 skill.md 文件以及 MCP 服务器结合使用,让用户能将你产品的全部能力安装到他们的 AI 工具中,而不只是他们正在阅读的那一页。

上下文菜单包含多个预构建选项,你可以通过将其标识符添加到配置中来启用。

OptionIdentifierDescription
复制页面copy将当前页面复制为 Markdown,以便作为 context 粘贴到 AI 工具中
以 Markdown 查看view以 Markdown 打开当前页面
询问助手assistant使用当前页面作为 context 打开 assistant
在 ChatGPT 中打开chatgpt使用当前页面作为 context 创建一个 ChatGPT 对话
在 Claude 中打开claude使用当前页面作为 context 创建一个 Claude 对话
在 Perplexity 中打开perplexity使用当前页面作为 context 创建一个 Perplexity 对话
在 Grok 中打开grok使用当前页面作为 context 创建一个 Grok 对话
在 Google AI Studio 中打开aistudio使用当前页面作为 context 创建一个 Google AI Studio 对话
在 Devin 中打开devin使用当前页面作为 context 创建一个 Devin 会话
在 Devin Desktop 中打开devin-desktop使用当前页面作为 context 打开 Devin Desktop。需要安装 Devin Desktop。
复制 MCP 服务器 URLmcp将你的 MCP 服务器 URL 复制到剪贴板
复制 MCP 安装命令add-mcp复制用于安装 MCP 服务器的 npx add-mcp 命令
连接到 Cursorcursor在 Cursor 中安装你托管的 MCP 服务器
连接到 VS Codevscode在 VS Code 中安装你托管的 MCP 服务器
连接到 Devindevin-mcp在 Devin 中安装你托管的 MCP 服务器
下载 PDFdownload-pdf将当前页面下载为 PDF
自定义选项Object向上下文菜单添加自定义选项
展开的上下文菜单,显示了“复制页面”“以 Markdown 查看”“在 ChatGPT 中打开”和“在 Claude 中打开”等菜单项。

在你的 docs.json 文件中添加 contextual 字段,并指定要包含的选项。 选项按你在数组中列出的顺序在菜单中显示。

{
 "contextual": {
   "options": [
     "copy",
     "view",
     "assistant",
     "chatgpt",
     "claude",
     "perplexity",
      "grok",
       "aistudio",
       "devin",
       "devin-desktop",
      "mcp",
      "cursor",
      "vscode",
      "devin-mcp",
      "download-pdf"
    ]
 }
}

默认情况下,上下文菜单显示在页面页眉中。你也可以使用 display 选项,将其配置为显示在目录侧边栏中。

{
  "contextual": {
    "options": ["copy", "view", "chatgpt", "claude"],
    "display": "toc"
  }
}
说明
header在页面顶部的上下文菜单中显示选项 (默认)
toc在目录侧边栏中显示选项

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

titlestringrequired

选项的标题。

descriptionstringrequired

选项的说明。当上下文菜单展开时显示于标题下方。

必须提供 iconsrc 之一。

iconstring

要从图标库中显示的图标。

可选值:

srcstring

用作图标的图像的路径或 URL。当你希望使用自定义图像而不是图标库中的图标时,请使用 src 代替 icon

可选值:

  • 项目中图像文件的路径(例如,/images/my-icon.svg
  • 外部托管图像的 URL(例如,https://example.com/icon.png
iconTypestring

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

可选值:regularsolidlightthinsharp-solidduotonebrands

hrefstring | objectrequired

选项的 href。简单链接使用字符串,带有 query 参数的动态链接使用对象。

Show href object
basestringrequired

选项的基础 URL。

queryobject[]

要附加到基础 URL 的 query 参数对象数组。

Show query object
keystringrequired

query 参数的 key。

valuestringrequired

query 参数的值。Mintlify 会将以下占位符替换为对应的值:

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

自定义选项示例:

{
    "contextual": {
        "options": [
            "copy",
            "view",
            "chatgpt",
            "claude",
            "perplexity",
            {
                "title": "功能请求",
                "description": "在 GitHub 上参与讨论,请求新功能",
                "icon": "plus",
                "href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests"
            }
        ]
    }
}

通过在页面 frontmatter 中添加 contextual 字段,可在特定页面覆盖全局的上下文菜单。你可以用它在服务条款页面上呈现 download-pdf 等页面专属操作,或在着陆页上完全隐藏该菜单。

页面级的 contextual 对象会替换该页面的全局配置。省略该字段即可继承 docs.json 的设置,将 options: [] 设为空数组则可在该页面禁用上下文菜单。

---
title: "服务条款"
contextual:
  options:
    - copy
    - download-pdf
  display: header
---

docs.json 中相同的字段和校验规则同样适用,包括自定义选项以及 display 设置。如果页面级的覆盖配置无效,Mintlify 将回退到全局的 contextual 配置。

Was this page helpful?Suggest editsRaise issue