LLMs.txt

如何让 Cursor、Windsurf、GitHub Copilot、ChatGPT 和 Claude 等 AI 工具理解 Nuxt UI 组件、主题和最佳实践。

什么是 LLMs.txt?

LLMs.txt 是一种专门为大型语言模型(LLM)设计的结构化文档格式。Nuxt UI 提供了 LLMs.txt 文件,其中包含我们组件库的全面信息,使 AI 工具能够轻松理解并协助 Nuxt UI 的开发。

这些文件经过优化,易于 AI 消费,并包含有关组件、API、使用模式和最佳实践的结构化信息。

可用路由

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

  • /llms.txt - 包含所有组件及其文档链接的结构化概述(约 5K token)
  • /llms-full.txt - 提供全面的文档,包括实现细节、示例、主题、可组合函数和迁移指南(约 1M+ token)

选择正确的文件

大多数用户应该从 /llms.txt 开始 - 它包含所有基本信息,并适用于标准 LLM 上下文窗口。仅当您需要全面的实现示例且您的 AI 工具支持大型上下文(200K+ token)时,才使用 /llms-full.txt

重要使用注意事项

@-符号必须手动输入 - 当使用 Cursor 或 Windsurf 等工具时,@ 符号必须在聊天界面中手动输入。复制粘贴会破坏工具将其识别为上下文引用的能力。

与 AI 工具一起使用

Cursor

Nuxt UI 提供了专门的 LLMs.txt 文件,您可以在 Cursor 中引用这些文件,以获得更好的 AI 协助进行组件开发。

如何使用

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

阅读更多关于 Cursor Web 和 Docs 搜索的信息

Windsurf

Windsurf 可以直接访问 Nuxt UI LLMs.txt 文件,以理解组件用法和最佳实践。

将 LLMs.txt 与 Windsurf 一起使用

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

阅读更多关于 Windsurf Web 和 Docs 搜索的信息

其他 AI 工具

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

ChatGPT、Claude 或其他 LLM 的示例