Jamdesk Documentation logo

Lokale Vorschau

Sieh dir deine Dokumentation auf deinem Rechner mit der Jamdesk CLI an, bevor du sie in die Produktion überführst. Änderungen erscheinen beim Bearbeiten.

Führe jamdesk dev (oder npx jamdesk dev) in einem Verzeichnis aus, das eine docs.json enthält. Dabei wird ein lokaler Server mit Hot Reload und Suche gestartet. Komponenten werden so dargestellt, wie in der Produktion.

Voraussetzungen

  • Node.js 22.18+ oder 24.11+ - Prüfe es mit node --version
  • Ein Dokumentationsprojekt - Mit einer docs.json-Konfigurationsdatei

Dev-Server starten

Installiere die CLI global und führe sie anschließend in deinem Dokumentationsverzeichnis aus:

npm install -g jamdesk
cd your-docs
jamdesk dev

Deine Dokumentation ist dann unter http://localhost:3000 verfügbar.

Was du erhältst

Hot Reload

Bearbeite MDX-Dateien und sieh die Änderungen sofort. Änderungen an docs.json und deiner style.css werden nach dem Neuladen angezeigt.

Volle Suche

Teste die Cmd+K-Suche mit deinen Inhalten

Alle Komponenten

Komponenten werden wie in der Produktion dargestellt

Design-Wechsel

Wechsle das Farbdesign

Benutzerdefinierter Port

Der Standardport ist 3000. Mit --port kannst du einen anderen angeben:

jamdesk dev --port 3001

Oder lege einen dauerhaften Standard in ~/.jamdeskrc fest:

{
  "defaultPort": 3001
}

Ausführlicher Modus

Zeige Build-Details mit dem Flag --verbose an:

jamdesk dev --verbose

Dies zeigt:

  • Erkennung von Dateiänderungen
  • Build-Dauer
  • Analyse der Navigation
  • Warnungen oder Fehler

Leistung beim ersten Start

Beim ersten Lauf von jamdesk dev werden Abhängigkeiten nach ~/.jamdesk installiert. Das dauert 30–60 Sekunden. Spätere Starts dauern weniger als 5 Sekunden.

Leere den Cache und erzwinge eine frische Installation:

jamdesk clean
jamdesk dev

Fehlerbehebung

Ein anderer Prozess verwendet Port 3000.

Option 1: Verwende einen anderen Port

jamdesk dev --port 3001

Option 2: Finde den Prozess und beende ihn

lsof -i :3000
kill -9 <PID>

Führe den Befehl in dem Verzeichnis aus, das deine docs.json-Datei enthält:

ls docs.json  # Should show the file
jamdesk dev
  1. Prüfe das Terminal auf Fehler
  2. Lade den Browser hart neu (Cmd+Shift+R)
  3. Starte den Entwicklungsserver neu
  4. Führe jamdesk clean aus und versuche es erneut

Führe die Diagnose aus:

jamdesk doctor

Sie prüft deine Umgebung und meldet Probleme.

Wie geht es weiter?

VS Code-Erweiterung

Starte den Entwicklungsserver über die Statusleiste von VS Code

Deployment

Erfahre mehr über den Build- und Deploy-Prozess