End-to-End-Tutorial
Vom leeren Repository zur live geschalteten Dokumentationsseite: Projekt erstellen, lokal prüfen, bereitstellen und optional eine eigene Domain konfigurieren.
Starten Sie mit einem leeren Repository und erstellen Sie eine live geschaltete Dokumentationsseite. Fügen Sie eine eigene Domain hinzu, sobald Sie bereit sind, und überspringen Sie bereits erledigte Schritte.
Voraussetzungen
- Ein GitHub-Konto
- Ein Repository mit Dokumentationsinhalten (oder verwenden Sie die Startervorlage)
- Node.js 20+, wenn Sie die CLI mit npm installieren möchten
Erstellen Sie Ihr erstes Projekt im Jamdesk-Dashboard und verbinden Sie ein Repository.
- Folgen Sie Projekte erstellen, um den Projektnamen, den Slug und den Dokumentationspfad festzulegen
- Installieren Sie bei entsprechender Aufforderung die GitHub App und gewähren Sie Zugriff auf das Repository (GitHub verbinden)
Verwenden Sie die Jamdesk CLI, um Seitenänderungen in der Vorschau anzuzeigen, bevor Sie sie an GitHub übertragen.
npm install -g jamdesk
cd your-docs
jamdesk devIhre lokale Vorschau läuft unter http://localhost:3000. Weitere Informationen finden Sie unter Lokale Vorschau.
Öffnen Sie eine .mdx-Seite in Ihrem Editor, speichern Sie eine Änderung und aktualisieren Sie die lokale Vorschau. Wenn alles richtig aussieht, veröffentlichen Sie die Änderung im nächsten Schritt mit dem Git-Workflow.
Jeder Push in Ihren konfigurierten Branch löst einen Build aus und veröffentlicht Ihre Dokumentation auf Ihrer Jamdesk-Subdomain.
git add .
git commit -m "Add docs content"
git push origin mainErsetzen Sie main durch den in Ihrem Projekt konfigurierten Branch, wenn Sie einen anderen Branch verwenden.
Nach Abschluss des Builds ist Ihre Dokumentation unter your-project.jamdesk.app live geschaltet. Weitere Informationen 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) - Erstellen Sie die im Dashboard angezeigten DNS-Einträge
- Warten Sie, bis die Verifizierung und SSL abgeschlossen sind
Informationen zur Fehlerbehebung finden Sie unter Eigene Domains.
End-to-End-Ablauf überprüfen
- Ihre Jamdesk-Subdomain wird geladen und zeigt den neuesten Build
- Die lokale Vorschau enthält dieselben Inhalte und dieselbe Navigation
- Falls konfiguriert, ist die eigene Domain verifiziert und stellt HTTPS bereit
- Die Build-Historie zeigt den neuesten Commit und die Zuordnung zum Autor
Optional: Unter /docs hosten
Wenn Sie Ihre Dokumentation unter einem Unterpfad wie example.com/docs bereitstellen möchten, lesen Sie Übersicht zur Bereitstellung und Hosting unter einem Unterpfad.