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 tokens)/llms-full.txt- 提供全面的文档,包括入门指南、API 参考、博客文章和部署指南(约 100 万+ tokens)
选择合适的文件
大多数用户应从
/llms.txt 开始 - 它包含全部必要信息,并能适配标准的 LLM 上下文窗口。仅当你需要全面的实现细节,且你的 AI 工具支持大上下文(200K+ tokens)时,才使用 /llms-full.txt。重要使用说明
@ 符号必须手动输入 - 在使用 Cursor 或 Windsurf 等工具时,@ 符号必须在聊天界面中手动键入。复制粘贴会破坏工具将其识别为上下文引用的能力。与 AI 工具配合使用
Cursor
Nuxt 提供了专门的 LLMs.txt 文件,你可以在 Cursor 中引用,以获得更好的 Nuxt 开发 AI 协助。
如何使用
- 直接引用:在提问时提及 LLMs.txt 的 URL
- 使用
@docs将这些特定 URL 添加到你的项目上下文中
阅读更多关于 Cursor Web 与 Docs Search 的内容
Windsurf
Windsurf 可以直接访问 Nuxt 的 LLMs.txt 文件,以理解框架用法和最佳实践。
在 Windsurf 中使用 LLMs.txt
- 使用
@docs引用特定的 LLMs.txt URL - 在你的 workspace 中创建引用这些 URL 的持久规则
阅读更多关于 Windsurf Web 与 Docs Search 的内容
其他 AI 工具
任何支持 LLMs.txt 的 AI 工具都可以使用这些路由来更好地理解 Nuxt。
适用于 ChatGPT、Claude 或其它 LLM 的示例
- "使用来自 https://nuxt.com/llms.txt 的 Nuxt 文档"
- "遵循来自 https://nuxt.com/llms-full.txt 的完整 Nuxt 指南"