LLMs.txt

Como fazer ferramentas de IA como Cursor, Windsurf, GitHub Copilot, ChatGPT e Claude entenderem os componentes, a tematização e as boas práticas do Nitro UI.

O que é o LLMs.txt?

LLMs.txt é um formato de documentação estruturado projetado especificamente para grandes modelos de linguagem (LLMs). O Nitro UI fornece arquivos LLMs.txt que contêm informações abrangentes sobre nossa biblioteca de componentes, facilitando que ferramentas de IA entendam e auxiliem no desenvolvimento com o Nitro UI.

Esses arquivos são otimizados para consumo por IA e contêm informações estruturadas sobre componentes, APIs, padrões de uso e boas práticas.

Rotas disponíveis

We provide LLMs.txt routes to help AI tools access our documentation:

  • /llms.txt - Contains a structured overview of all components and their documentation links (~5K tokens)
  • /llms-full.txt - Provides comprehensive documentation including implementation details, examples, theming and composables (~1M+ tokens)

Escolhendo o arquivo certo

Most users should start with /llms.txt - it contains all essential information and works with standard LLM context windows. Use /llms-full.txt only if you need comprehensive implementation examples and your AI tool supports large contexts (200K+ tokens).

Notas importantes de uso

@-symbol must be typed manually - When using tools like Cursor or Windsurf, the @ symbol must be typed by hand in the chat interface. Copy-pasting breaks the tool's ability to recognize it as a context reference.

Uso com ferramentas de IA

Cursor

O Nitro UI fornece arquivos LLMs.txt especializados que você pode referenciar no Cursor para uma melhor assistência de IA no desenvolvimento de componentes.

Como usar:

  1. Referência direta: Mencione as URLs do LLMs.txt ao fazer perguntas
  2. Adicione estas URLs específicas ao contexto do seu projeto usando @docs

Read more about Cursor Web and Docs Search

Windsurf

O Windsurf pode acessar diretamente os arquivos LLMs.txt do Nitro UI para entender o uso dos componentes e as boas práticas.

Usando o LLMs.txt com o Windsurf:

  • Use @docs to reference specific LLMs.txt URLs
  • Create persistent rules referencing these URLs in your workspace

Read more about Windsurf Web and Docs Search

Outras ferramentas de IA

Qualquer ferramenta de IA que suporte LLMs.txt pode usar essas rotas para entender melhor o Nitro UI.

Exemplos para ChatGPT, Claude ou outros LLMs: