Nuxt LLMs.txt

如何让 Cursor、Windsurf、GitHub Copilot、ChatGPT 和 Claude 等 AI 工具理解 Nuxt 的概念、API 及最佳实践。

什么是 LLMs.txt?

LLMs.txt 是一种专为大型语言模型(LLMs)设计的结构化文档格式。Nuxt 提供了包含框架全面信息的 LLMs.txt 文件,使 AI 工具能轻松理解并协助进行 Nuxt 开发。

这些文件针对 AI 消费进行了优化,包含关于概念、API、使用模式和最佳实践的结构化信息。

可用路由

我们提供 LLMs.txt 路由,帮助 AI 工具访问我们的文档:

  • /llms.txt - 包含所有文档页面及其链接的结构化概览(约 5K 令牌)
  • /llms-full.txt - 提供全面的文档内容,包括入门指南、API 参考、博客文章和部署指南(约 100 万+ 令牌)

选择合适的文件

大多数用户应从 /llms.txt 开始 — 该文件包含所有核心信息,并适用于标准 LLM 上下文窗口。仅当你需要完整的实现细节且 AI 工具支持大上下文(20 万+ 令牌)时,才使用 /llms-full.txt

重要使用说明

@ 符号必须手动输入 — 使用 Cursor 或 Windsurf 等工具时,@ 符号必须在聊天界面中手动输入。复制粘贴会导致工具无法识别其为上下文引用。

与 AI 工具的使用

Cursor

Nuxt 提供专门的 LLMs.txt 文件,你可以在 Cursor 中引用它们,以获得更佳的 Nuxt 开发 AI 协助。

使用方法

  1. 直接引用:在提问时提及 LLMs.txt 的 URL
  2. 使用 @docs 将这些特定 URL 添加到项目上下文中

阅读更多关于 Cursor Web 和文档搜索

Windsurf

Windsurf 可以直接访问 Nuxt 的 LLMs.txt 文件,了解框架的使用和最佳实践。

在 Windsurf 中使用 LLMs.txt

  • 使用 @docs 来引用特定的 LLMs.txt URL
  • 在工作区创建持久规则,引用这些 URL

阅读更多关于 Windsurf Web 和文档搜索

其他 AI 工具

任何支持 LLMs.txt 的 AI 工具都可以使用这些路由,更好地理解 Nuxt。

ChatGPT、Claude 或其他 LLM 的示例