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、使用模式和最佳实践的结构化信息。

Available routes

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

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

Choosing the Right File(选择正确的文件)

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

重要使用注意事项

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

AI工具使用

Cursor

Nuxt UI提供了专门的LLMs.txt文件,您可以在Cursor中引用这些文件,以便更好地为组件开发提供AI帮助。

用途:

  1. Direct reference:提问时请提及LLMs.txt URL
  2. 使用@docs将这些特定URL添加到项目上下文

在Cursor中阅读有关提示和@提及的详细信息

Windsurf

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

Using LLMs.txt with Windsurf:

  • Use@docsto reference specific LLMs.txt URL
  • 在您的工作区中创建引用这些URL的永久规则

Read more about Windsurf Web and Windsurf Search

Other AI Tools

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

ChatGPT、Claude或其他LLM示例: