Nuxt LLMs.txt

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

什么是 LLMs.txt？

LLMs.txt 是一种专门为大型语言模型（LLM）设计的结构化文档格式。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 的示例