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
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
llms-full.txt
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
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.