Zum Hauptinhalt springen

Agentenlesbare Inhalte veröffentlichen

Dieselbe Dokumentation als Roh-Markdown, LLM-Indizes, ausgehandeltes Markdown und schreibgeschützte MCP-Tools bereitstellen.

Ginko Docs stellt agentenlesbare Formen derselben kanonischen Seiten bereit, die auch die Website speisen. Du brauchst weder einen zweiten Markdown-Baum noch ein Skript, das Quelldateien nach public/ kopiert.

Statische Dateien verwenden

Eine statische Generierung schreibt diese öffentlichen Artefakte:

  • /raw/**.md für normalisierte Markdown-Versionen veröffentlichter Seiten;
  • /llms.txt für einen kompakten, gegliederten Index;
  • /llms-full.txt für die ausgewählten Seiten in einem gemeinsamen Markdown-Dokument.

Zum Beispiel ist /docs/getting-started auch unter /raw/docs/getting-started.md verfügbar. Ein zweisprachiger Build erzeugt außerdem sprachspezifische Raw-Routen sowie /de/llms.txt und /de/llms-full.txt.

Diese Dateien funktionieren auf einem gewöhnlichen Static Host, weil sie vorgerendert werden. Die Produktionsausgabe schließt Entwürfe aus; Data-Collections wie authors werden nicht zu öffentlichen Agentenseiten.

terminal
pnpm generate
find .output/public/raw -type f -name '*.md'

Prüfe .output/public/llms.txt und .output/public/llms-full.txt vor dem Deployment.

Nitro-abhängige Funktionen unterscheiden

Bei einem SSR- oder Hybrid-Deployment kann Nitro für die normale Seiten-URL Markdown zurückgeben, wenn die Anfrage text/markdown akzeptiert:

terminal
pnpm build
terminal
curl -H 'Accept: text/markdown' \
  https://docs.example.com/de/dokumentation/erste-schritte

Auch der Endpunkt /mcp benötigt einen laufenden Nitro-Server. Er stellt die schreibgeschützten Tools list-pages und get-page bereit. Beide lesen /llms.txt und kanonisches Raw-Markdown, statt einen weiteren Index zu pflegen.

Ein Static Host kann weder die Middleware für Content Negotiation noch den MCP-Endpunkt ausführen. Verweise statische Clients stattdessen auf /raw/**.md, /llms.txt oder /llms-full.txt.

Das Seitenmenü konfigurieren

Jede Dokumentationsseite behält die primären Aktionen Markdown kopieren, Link kopieren und Markdown anzeigen. markdownActions steuert nur die optionalen Einträge für ChatGPT, Claude und MCP im geteilten Menü:

app/app.config.ts
export default defineAppConfig({
  ginkoDocs: {
    markdownActions: {
      chatGpt: false,
      claude: false,
      mcp: true,
    },
  },
});

Diese booleschen Werte blenden Menüeinträge aus. Sie deaktivieren weder Raw-Markdown und LLM-Dateien noch Content Negotiation oder den /mcp-Server.

Eigene MDC-Komponenten behalten in Agenten-Markdown normalerweise eine explizite Komponentendarstellung. Füge nur dann einen serverseitigen Serializer hinzu, wenn eine verständlichere Textform nötig ist; eigene Komponenten zeigt diese Grenze.