Die llms.txt-Datei ist ein Branchenstandard, der LLMs hilft, Inhalte effizienter zu indexieren – ähnlich wie eine Sitemap für Suchmaschinen. KI-Tools können diese Datei nutzen, um die Struktur Ihrer Dokumentation zu verstehen und relevante Inhalte zu Benutzeranfragen zu finden. Mintlify hostet automatisch eine llms.txt-Datei im Stammverzeichnis Ihres Projekts, die alle verfügbaren Seiten Ihrer Dokumentation auflistet. Diese Datei ist stets aktuell und erfordert keine Wartung. Optional können Sie eine eigene llms.txt-Datei im Stammverzeichnis Ihres Projekts hinzufügen. Rufen Sie Ihre llms.txt auf, indem Sie /llms.txt an die URL Ihrer Dokumentations-Website anhängen. llms.txt dieser Website öffnen

Struktur von llms.txt

Eine llms.txt-Datei ist eine einfache Markdown-Datei, die Folgendes enthält:
  • Seitentitel als H1-Überschrift.
  • Strukturierte Inhaltsabschnitte mit Links und einer Beschreibung jeder Seite Ihrer Dokumentation.
Example llms.txt
# Example product docs

## Guides
- [Getting started](https://example.com/docs/start): Intro guide
- [Install](https://example.com/docs/install): Setup steps

## Reference
- [API](https://example.com/docs/api): Endpoint list and usage
Dieser strukturierte Ansatz ermöglicht es LLMs, Ihre Dokumentation auf hoher Ebene effizient zu verarbeiten und relevante Inhalte für Benutzeranfragen zu finden. Das verbessert die Genauigkeit und Geschwindigkeit von KI-gestützten Suchen in der Dokumentation.

llms-full.txt

Die Datei llms-full.txt fasst Ihre gesamte Dokumentationssite in einer einzigen Datei zusammen, um sie als Kontext für KI-Tools bereitzustellen, und wird von LLMs indexiert. Mintlify stellt automatisch eine llms-full.txt im Stammverzeichnis Ihres Projekts bereit. Rufen Sie Ihre llms-full.txt auf, indem Sie /llms-full.txt an die URL Ihrer Dokumentationssite anhängen. llms-full.txt dieser Site öffnen

Benutzerdefinierte Dateien

Um eine benutzerdefinierte Datei llms.txt oder llms-full.txt hinzuzufügen, erstellen Sie eine llms.txt- oder llms-full.txt-Datei im Stammverzeichnis Ihres Projekts. Das Hinzufügen einer benutzerdefinierten Datei überschreibt die automatisch generierte Datei mit demselben Namen. Wenn Sie eine benutzerdefinierte Datei löschen, wird wieder die Standarddatei verwendet. Ihre benutzerdefinierte llms.txt- oder llms-full.txt-Datei muss einen Seitentitel als H1-Überschrift enthalten. Weitere Inhalte sind optional. Siehe Format in der llms.txt-Spezifikation für weitere Informationen zu optionalen Abschnitten und Best Practices.