Deployment-Methode wählen

docmd bietet vier Wege, Ihre Dokumentation live zu schalten. Alle produzieren dasselbe Ergebnis — eine statische Website, die auf GitHub Pages oder einem Hosting-Anbieter Ihrer Wahl bereitgestellt wird — unterscheiden sich jedoch im gewünschten Kontrollgrad und Ausgangspunkt.

Schnelle Entscheidungsmatrix

Szenario-Leitfaden

„Ich möchte in unter zwei Minuten live gehen, ohne Konfiguration"

Verwenden Sie die GitHub App. Installieren, Repository auswählen, fertig. Sie erkennt Ihre Konfiguration, generiert den Workflow, aktiviert GitHub Pages und stellt bereit — ohne dass Sie eine einzige Datei anfassen.

„Ich starte eine brandneue Dokumentationswebsite"

Verwenden Sie die Starter-Vorlage. Klicken Sie auf „Vorlage verwenden", aktualisieren Sie docmd.config.json mit Titel und URL, aktivieren Sie GitHub Pages einmalig und pushen. Alles ist bereits vorkonfiguriert.

„Ich habe eine bestehende CI/CD-Pipeline und möchte Docs hinzufügen"

Verwenden Sie die GitHub Action. Fügen Sie docmd-io/deploy@v1 in Ihren bestehenden Workflow ein. Sie lässt sich sauber mit anderen Schritten kombinieren — Tests ausführen, App bauen, dann Docs bauen, alles in einem Job.

„Ich deploye auf Vercel, Netlify, Docker oder meinen eigenen Server"

Verwenden Sie das Deployer-Paket. Führen Sie npx @docmd/core deploy --vercel (oder --netlify, --docker, --nginx) aus, um anbieterspezifische Konfigurationsdateien zu generieren, die auf Ihre docmd.config.json zugeschnitten sind.

„Ich bin in einem Monorepo mit Docs in einem Unterverzeichnis"

Sowohl die GitHub App als auch das Deployer-Paket behandeln dies automatisch. Die App erkennt Konfigurationen im gesamten Repository-Baum und injiziert das korrekte --cwd-Flag.

Bei Verwendung der GitHub Action übergeben Sie --cwd manuell:

- run: npx @docmd/core build --cwd packages/docs

„Ich möchte Docs bei jedem Pull Request in der Vorschau sehen"

Kombinieren Sie die GitHub Action mit einem PR-Vorschau-Dienst (z. B. Cloudflare Pages Preview Deployments oder einer selbst gehosteten Vorschauumgebung). Siehe Änderungen in der Vorschau anzeigen für eine vollständige Anleitung.

Wie die Methoden zusammenwirken

Diese Methoden schließen sich nicht gegenseitig aus. Ein typischer Entwicklungspfad sieht so aus:

Mit der GitHub App beginnen (schnellster Weg zu Live)
  ↓
Die generierte Workflow-Datei nach Bedarf anpassen
  ↓
Deployer-Paket hinzufügen für Nginx/Docker-Konfigurationen
  ↓
Action in eine umfassendere CI/CD-Pipeline integrieren

Weiterführende Links

• GitHub Action Referenz
• GitHub App Referenz
• Starter-Vorlage Referenz
• Deployer-Paket Referenz
• GitHub Actions CI/CD Leitfaden
• Änderungen in der Vorschau anzeigen