Tiramisu Docs

Integrations

llms.txt

Generieren Sie maschinenlesbare Dokumentation für KI-Assistenten mit llms.txt und llms-full.txt.

Tiramisu Docs generiert maschinenlesbare Dokumentationsdateien, die KI-Assistenten helfen, Ihre Dokumentation zu verstehen, ohne Ihre Website zu scrapen.

Endpunkte

Drei Endpunkte werden automatisch generiert:

EndpunktBeschreibung
/llms.txtEine kompakte Zusammenfassung Ihrer Dokumentationsstruktur mit Links zu jeder Seite
/llms-full.txtDer vollständige Inhalt aller Dokumentationsseiten im Klartext
/skill.mdEine Claude Code Skill-Datei, die Claude den Umgang mit Ihrer Dokumentation beibringt

llms.txt

Die Datei /llms.txt folgt dem llms.txt-Standard — einem leichtgewichtigen Format, das KI-Modellen hilft, Ihre Dokumentation zu entdecken und zu navigieren. Sie enthält:

  • Den Titel und die Beschreibung Ihrer Website
  • Eine Liste aller Dokumentationsseiten mit ihren URLs und Beschreibungen
  • Links zur Volltext-Version

llms-full.txt

Der Endpunkt /llms-full.txt liefert den vollständigen Inhalt jeder Dokumentationsseite im Klartextformat. Dies ist nützlich für KI-Assistenten, die Ihre gesamte Dokumentation aufnehmen müssen.

skill.md

Der Endpunkt /skill.md generiert eine Claude Code Skill-Datei. Diese Datei kann als Claude Code Skill verwendet werden, um Claude über die Struktur und den Inhalt Ihrer Dokumentation zu informieren.

Generator-Funktionen

Diese Endpunkte werden von drei Funktionen unterstützt, die Sie in Ihren SvelteKit-Routen verwenden können:

typescript 
import {
  generateLlmsTxt,
  generateLlmsFullTxt,
  generateSkillMd,
} from "@tiramisu-docs/kit";

Jede Funktion gibt einen String zurück, den Sie von einem SvelteKit-Endpunkt aus bereitstellen können:

typescript 
// src/routes/llms.txt/+server.ts
import { generateLlmsTxt } from "@tiramisu-docs/kit";

export const GET = async () => {
  const content = await generateLlmsTxt();
  return new Response(content, {
    headers: { "Content-Type": "text/plain" },
  });
};