Jamdesk Documentation logo

Lokale Vorschau

Mit der Jamdesk CLI kannst du deine Dokumentation lokal prüfen, bevor du sie in die Produktion stellst. Änderungen werden sofort angezeigt.

Führe jamdesk dev (oder npx jamdesk dev) in einem beliebigen Verzeichnis aus, das eine docs.json enthält, um einen lokalen Server mit Hot Reload, vollständiger Suche und allen Komponenten zu starten, die exakt wie in der Produktion funktionieren.

Voraussetzungen

Stelle vor dem Start sicher, dass Folgendes vorhanden ist:

  • Node.js 20+ – Überprüfe dies mit node --version
  • Ein Dokumentationsprojekt – Mit einer docs.json-Konfigurationsdatei

Dev-Server starten

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

npm install -g jamdesk
cd your-docs
jamdesk dev

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

Was du erhältst

Hot Reload

Bearbeite MDX-Dateien und sieh Änderungen sofort. Änderungen an docs.json und deiner style.css werden beim Aktualisieren übernommen.

Vollständige Suche

Teste die Cmd+K-Suche mit deinen tatsächlichen Inhalten.

Alle Komponenten

Jede Komponente funktioniert exakt wie in der Produktion.

Theme-Wechsel

Teste sowohl den hellen als auch den dunklen Modus.

Benutzerdefinierter Port

Der Standardport ist 3000. Wenn er bereits verwendet wird, gib einen anderen Port an:

jamdesk dev --port 3001

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

{
  "defaultPort": 3001
}

Ausführlicher Modus

Zeige detaillierte Build-Informationen mit dem Flag --verbose an:

jamdesk dev --verbose

Dies zeigt:

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

Leistung beim ersten Start

Beim ersten Ausführen von jamdesk dev werden Abhängigkeiten in ~/.jamdesk installiert. Dies dauert 30–60 Sekunden. Nachfolgende Starts erfolgen in weniger als 5 Sekunden.

So löschst du den Cache und erzwingst eine neue 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>

Stelle sicher, dass du dich in dem Verzeichnis befindest, das deine docs.json-Datei enthält:

ls docs.json  # Should show the file
jamdesk dev

Führe diese Schritte aus:

  1. Überprüfe das Terminal auf Fehler
  2. Aktualisiere den Browser vollständig (Cmd+Shift+R)
  3. Starte den Dev-Server neu
  4. Führe jamdesk clean aus und versuche es erneut

Führe eine Diagnose aus:

jamdesk doctor

Dabei werden deine Umgebung überprüft und Probleme erkannt.

Wie geht es weiter?

VS Code-Erweiterung

Starte den Dev-Server über die Statusleiste von VS Code

Bereitstellung

Erfahre mehr über den Build- und Bereitstellungsprozess