Zum Inhalt springen
Projekt startenStarten

API-Doku

Docs für die Menschen und die Agents, die deine API nutzen. Guides und die API-Referenz unter /docs auf deiner Domain, in jeder Sprache des Projekts.

Was es hinzufügt

  • apps/docs, gebaut mit Blume: Guides in MDX und die API-Referenz, erzeugt aus dem OpenAPI-Dokument deiner Operationen. Eine neue Operation erscheint in der Referenz mit ihrer eigenen Beschreibung.
  • Die Docs unter /docs auf deiner Hauptdomain: Die App leitet /docs per Rewrite an das Deployment der Docs weiter.
  • Eine eigene llms.txt und eine Markdown-Kopie jeder Seite, für Agents.
  • Guides in jeder Sprache des Projekts. pnpm --filter docs translate schreibt die fehlenden Übersetzungen mit Claude.

Einrichten

pnpm dev startet auch die Docs unter http://localhost:4321/docs, und die App liefert sie unter http://localhost:3000/docs aus.

Lege zum Deployen ein zweites Vercel-Projekt an, mit Root Directory apps/docs und mit SITE_URL auf der Produktions-URL der App. Setze dann DOCS_ORIGIN in der App auf die URL des Docs-Projekts.

Vor dem Livegang

Das Docs-Projekt ist deployt, und /docs auf der Hauptdomain zeigt es.

Weglassen oder später hinzufügen

Lass docs in --modules weg, um mit nur einer App zu starten. Um die Docs zu einem bestehenden Projekt hinzuzufügen, bitte deinen Agent, den Skill add-module zu nutzen.

Starte einen Befehl. Die CLI fragt den Rest, und dein Agent macht von dort aus weiter.

pnpm create turbinekit my-app
Prompt ansehen

Füge ihn in einen Agent ein, der Befehle ausführen kann, etwa Claude Code, Codex oder Cursor. Der Prompt ist auf Englisch.

Create a new TurbineKit project with me.
Talk to me in German.

TurbineKit (https://turbinekit.dev) is an open-source Turborepo and Next.js starter. Its CLI, create-turbinekit, needs Node.js 24 and pnpm 10 (run `corepack enable` once).

1. Run `pnpm dlx create-turbinekit --help` to see its options.
2. Ask me its questions one at a time, with their defaults: the folder, the product name, one sentence about the product, the company or legal name, the contact email, the languages and the modules. Skip what I have already told you.
3. The CLI only asks questions in an interactive terminal, so run it with my answers as options and `--yes`. Show me the command before you run it.
4. In the new folder, read AGENTS.md. Then do "1. Minimal setup" in SETUP.md, and tick each box you finish.
5. Tell me the URL of the running app, and which services SETUP.md lists next.

Keine Anmeldung, keine API-Keys. Braucht Node.js 24 und pnpm 10.