引言
Cursor 内置了一系列已爬取、索引并准备好作为上下文使用的第三方文档。您可以通过使用 @Docs
符号来访问这些文档。您可以在这里找到我们默认预爬取文档的列表。

使用 @Docs 命令引用第三方文档
添加自定义文档
如果您想爬取和索引尚未提供的自定义文档,可以通过 @Docs
> 添加新文档
来完成。在粘贴您想要的文档 URL 后,将出现以下模态框:

添加自定义文档的模态框
然后,Cursor 将索引并学习该文档,您将能够像使用任何其他文档一样将其用作上下文。如果您想索引所有子页面和子目录,请确保在 URL 末尾添加斜杠。

Cursor 正在索引新添加的文档
Cursor 会自动保持文档索引并定期重新索引,以确保它们随着编辑或更改保持最新状态。
管理自定义文档
在 Cursor 设置
> 功能
> 文档
下,您将看到已添加的文档。您可以在此处编辑、删除或添加新文档。

在设置中管理自定义文档
基本用法
1. 引用预设文档
在聊天或 Cmd K 中输入 @Docs,然后选择要引用的文档库。
@Docs React
2. 添加新文档
输入 @Docs,选择"添加新文档",然后粘贴文档 URL。
3. 指定具体查询
结合文档库和具体查询以获取更相关的结果。
@Docs React hooks
最佳实践
-
使用具体查询
结合文档名称和特定查询关键词,获取更精准的信息。
-
添加完整域名
添加自定义文档时,确保URL包含完整域名,并在需要爬取整个站点时添加末尾斜杠。
-
定期更新
对于快速变化的文档,可以在设置中手动触发重新索引,确保获取最新内容。
常见使用场景
1. 学习新框架
在学习新技术时引用官方文档,让AI结合具体上下文解释概念。
请求:"@Docs Vue 如何使用组合式API?"
2. 解决特定问题
在遇到编程问题时,引用相关文档寻求解决方案。
请求:"@Docs TypeScript 如何处理泛型约束?"
3. 团队文档参考
添加团队内部文档网站,用于查询团队特定流程和规范。
总结
@Docs 命令是 Cursor 中强大的文档引用工具,它允许您:
- 访问大量预索引的第三方文档
- 添加和索引自定义文档
- 在聊天中直接引用相关文档内容
- 管理和更新文档索引
通过有效利用这一功能,您可以显著提高编程效率,减少在外部浏览器中查找信息的需求。