Jak utworzyć plik llms.txt
Opublikowano:
Napisanie pliku llms.txt zajmuje około dziesięciu minut. Ten przewodnik krok po kroku omawia każdy element po kolei i kończy się gotowym plikiem, który możesz wkleić i dostosować.
1. Zacznij od tytułu H1
Pierwsza linia musi być pojedynczym nagłówkiem H1 — nazwą Twojego projektu lub witryny. Jest to jedyny bezwzględnie wymagany element tego formatu.
# Acme Docs
2. Dodaj podsumowanie w formie cytatu
Bezpośrednio pod tytułem dodaj jedno- lub dwuzdaniowy cytat blokowy. To kontekst, który model językowy czyta jako pierwszy, więc niech będzie konkretny: czym jest witryna i dla kogo jest przeznaczona.
> Acme is a payments API. This file links to the docs an LLM needs to integrate and debug Acme.
3. (Opcjonalnie) Dodaj kilka linijek tekstu
Przed jakimkolwiek nagłówkiem sekcji możesz dodać zwykłe akapity z dodatkowym wprowadzeniem. Nie używaj tu nagłówków — ogranicz się do jednego lub dwóch zdań.
4. Pogrupuj odnośniki w sekcjach H2
Każda sekcja to nagłówek H2, po którym następuje lista markdown. Każdy element jest odnośnikiem z opcjonalnym opisem po dwukropku.
## Docs - [Quickstart](https://acme.com/docs/quickstart): Integrate in five minutes - [API reference](https://acme.com/docs/api): Every endpoint and parameter ## Examples - [Sample app](https://acme.com/examples/app): A working end-to-end example
Używaj bezwzględnych adresów URL z https i skup opisy na tym, czego potrzebuje deweloper lub model — a nie na treściach marketingowych.
5. Wykorzystaj sekcję „Optional” na elementy dodatkowe
Sekcja dosłownie nazwana ## Optional ma specjalne znaczenie: jej odnośniki można pominąć, gdy potrzebny jest krótszy kontekst. Umieść tu dzienniki zmian, wpisy blogowe i drugorzędne materiały referencyjne.
6. Hostuj plik w katalogu głównym
Udostępnij plik pod adresem https://yourdomain.com/llms.txt z nagłówkiem Content-Type: text/plain. Duże witryny często publikują dodatkowo plik llms-full.txt z pełną, rozwiniętą treścią.
7. Sprawdź plik przed publikacją
Wklej swoją domenę do walidatora. Sprawdza on strukturę, potwierdza, że każdy odnośnik faktycznie działa, i wypisuje dokładnie to, co należy poprawić. Celuj w wynik 100/100.