Skip to main content

@Docs

@Docs 上下文提供者 允许您在 Continue 中直接与您的文档进行交互。此功能使您能够索引任何静态站点或 GitHub 的 Markdown 页面，从而在编码时更轻松地访问和利用您的文档。

启用 @Docs 上下文提供者​

要启用@Docs上下文提供程序，您需要将其添加到config.json文件中的上下文提供程序列表中。

{
  "contextProviders": [
    {
      "name": "docs"
    }
  ]
}

工作原理​

@Docs 上下文提供程序通过爬取指定的文档站点、生成嵌入并将其本地存储来工作。此过程允许快速高效地访问您的文档内容。

  1. 我们爬取指定的文档站点
  2. 为内容生成嵌入
  3. 将嵌入存储在您的本地机器上
  4. 通过@Docs上下文提供者提供对索引内容的访问

预索引文档站点​

我们提供了一系列预索引的文档站点，适用于流行的框架和库。您可以查看可用的预索引站点列表并在此请求添加。

索引您自己的文档​

通过 @Docs 上下文提供者​

要添加单个文档站点，我们建议使用@Docs上下文提供者。

  1. 在聊天面板中输入 @Docs，然后按回车键
  2. 输入 "add" 并选择 "Add Docs" 选项
  3. 在对话框中输入所需信息

提交后索引将开始。

通过 config.json​

要添加多个文档站点，我们建议将它们批量添加到您的config.json文件中。保存文件后，索引将开始。

文档的配置模式如下：

"docs": [
    {
    "title": "Continue",
    "startUrl": "https://docs.continue.dev/intro",
    "rootUrl": "https://docs.continue.dev",
    "faviconUrl": "https://docs.continue.dev/favicon.ico",
  }
]
  • title: 文档站点的名称，用于在用户界面中进行标识。
  • startUrl: 索引过程应开始的URL。
  • rootUrl: 文档站点的基础URL，用于确定要索引的页面。
  • faviconUrl: 网站图标的URL，用于在用户界面中进行视觉识别。

配置​

与@Codebase 上下文提供者配置一样，您可以通过nRetrieve、nFinal和useReranking来调整文档上下文提供者的行为。

config.json
{
  "contextProviders": [
    {
      "name": "docs",
      "params": {
        "nRetrieve": 25,
        "nFinal": 5,
        "useReranking": true
      }
    }
  ]
}

使用 useChromiumForDocsCrawling 抓取动态生成的站点​

默认情况下，我们使用一个较轻量级的工具来爬取文档站点，该工具无法渲染使用JavaScript动态生成的站点。

如果你想爬取一个动态生成的网站，或者在尝试爬取网站时遇到错误，你可以在config.json中启用实验性的useChromiumForDocsCrawling功能。这将下载并安装Chromium到~/.continue/.utils。

config.json
"experimental": {
    "useChromiumForDocsCrawling": true
}

常见问题解答​

索引内容多久更新一次？​

目前我们不会自动重新索引您的文档。如果您想强制重新索引，可以使用以下命令：Continue: Docs Force Re-Index。