End-to-End-Tutorial
Vom leeren Repo zur Live-Dokumentationsseite: Projekt anlegen, lokal in der Vorschau ansehen, bereitstellen und optional eine eigene Domain einrichten.
Vom leeren Repo zur Live-Dokumentationsseite. Überspringen Sie Schritte, die Sie bereits erledigt haben.
Voraussetzungen
- Ein GitHub-Konto
- Ein Repository mit Dokumentationsinhalten (oder verwenden Sie die Starter-Vorlage)
- Node.js 22.18+ oder 24.11+, falls Sie die CLI über npm installieren möchten
Legen Sie im Jamdesk-Dashboard ein Projekt an und verbinden Sie ein Repository.
- Folgen Sie Projekte erstellen, um Projektname, Slug und Dokumentationspfad festzulegen
- Installieren Sie bei Aufforderung die GitHub-App und gewähren Sie Zugriff auf das Repository (GitHub verbinden)
Sehen Sie Seitenänderungen mit der Jamdesk-CLI in der Vorschau an, bevor Sie sie an GitHub übertragen.
npm install -g jamdesk
cd your-docs
jamdesk devIhre lokale Vorschau läuft unter http://localhost:3000. Mehr dazu unter Lokale Vorschau.
Öffnen Sie eine .mdx-Seite in Ihrem Editor. Speichern Sie eine Änderung und laden Sie die lokale Vorschau neu. Veröffentlichen Sie sie mit dem Git-Workflow im nächsten Schritt.
Jeder Push auf den konfigurierten Branch löst einen Build aus. Der Build wird auf Ihrer Jamdesk-Subdomain veröffentlicht.
git add .
git commit -m "Add docs content"
git push origin mainErsetzen Sie main durch den konfigurierten Branch Ihres Projekts.
Ihre Dokumentation ist unter your-project.jamdesk.app online, sobald der Build abgeschlossen ist. Details finden Sie unter Bereitstellung.
Stellen Sie Ihre Dokumentation über Ihre eigene Domain statt über die Jamdesk-Subdomain bereit.
- Gehen Sie im Jamdesk-Dashboard zu Settings → Domains
- Fügen Sie Ihre Domain hinzu (zum Beispiel
docs.example.com) - Legen Sie die im Dashboard angezeigten DNS-Einträge an
- Warten Sie, bis Verifizierung und SSL abgeschlossen sind
Zur Fehlerbehebung siehe Eigene Domains.
End-to-End-Ablauf überprüfen
- Ihre Jamdesk-Subdomain lädt und zeigt den neuesten Build
- Die lokale Vorschau zeigt denselben Inhalt und dieselbe Navigation
- Falls konfiguriert, ist die eigene Domain verifiziert und stellt HTTPS bereit
- Der Build-Verlauf zeigt den neuesten Commit und die Zuordnung des Autors
Optional: Unter /docs hosten
Um die Dokumentation unter einem Unterpfad wie example.com/docs bereitzustellen, siehe Bereitstellungsübersicht und Hosting unter Unterpfad.