llms.txt
na raiz do seu projeto que lista todas as páginas disponíveis na sua documentação. Esse arquivo está sempre atualizado e não requer manutenção. Você também pode adicionar um arquivo llms.txt
personalizado à raiz do seu projeto.
Visualize seu llms.txt
adicionando /llms.txt
à URL do seu site de documentação.
Abrir o llms.txt deste site.
Estrutura do llms.txt
llms.txt
é um arquivo Markdown simples que contém:
- Título do site como um cabeçalho H1.
- Seções de conteúdo estruturadas com links e uma descrição de cada página da sua documentação.
Example llms.txt
llms-full.txt
llms-full.txt
reúne todo o seu site de documentação em um único arquivo como contexto para ferramentas de IA e é indexado pelo tráfego de LLMs.
A Mintlify hospeda automaticamente um llms-full.txt
na raiz do seu projeto. Visualize seu llms-full.txt
adicionando /llms-full.txt
ao URL do seu site de documentação.
Abrir o llms-full.txt deste site.
Arquivos personalizados
llms.txt
ou llms-full.txt
, crie um llms.txt
ou llms-full.txt
na raiz do seu projeto. Adicionar um arquivo personalizado substituirá o arquivo gerado automaticamente com o mesmo nome. Se você excluir o arquivo personalizado, o arquivo padrão voltará a ser usado.
Seu arquivo personalizado llms.txt
ou llms-full.txt
deve incluir o título do site como um cabeçalho H1. O restante do conteúdo é opcional. Consulte Format na especificação do llms.txt
para mais informações sobre seções opcionais e boas práticas.