Jamdesk Documentation logo

VS-Code-Erweiterung

Starten, stoppen und neu starten Sie den Jamdesk-Dev-Server über die Visual-Studio-Code-Statusleiste mit Ein-Klick-Steuerung und automatischer Browser-Vorschau.

Zeigen Sie eine Vorschau Ihrer Dokumentation an, ohne Visual Studio Code zu verlassen. Die Jamdesk-Erweiterung fügt eine Schaltfläche zur Statusleiste hinzu, die jamdesk dev startet, den Server überwacht und Ihren Browser öffnet, sobald er bereit ist. Kein Terminal erforderlich.

Voraussetzungen

  • Jamdesk CLI installiert (npm install -g jamdesk)
  • Ein Workspace mit einer Datei docs.json

Erweiterung installieren

Suchen Sie im VS-Code-Bereich Extensions nach Jamdesk (Cmd+Shift+X unter macOS, Ctrl+Shift+X unter Windows/Linux) und klicken Sie auf Install. Alternativ können Sie die Erweiterung direkt über den VS Code Marketplace installieren.

Die Erweiterung wird automatisch aktiviert, wenn Ihr Workspace eine Datei docs.json enthält. In der Statusleiste wird eine Wiedergabeschaltfläche angezeigt.

Dev-Server starten

Klicken Sie auf die Wiedergabeschaltfläche in der Statusleiste, um den Dev-Server zu starten. Die Erweiterung:

  1. Startet jamdesk dev als untergeordneten Prozess
  2. Überwacht die Ausgabe, um zu erkennen, wann der Server bereit ist
  3. Öffnet Ihren Browser mit der lokalen Vorschau, sofern das automatische Öffnen aktiviert ist

Die Statusleiste zeigt den aktuellen Serverstatus an: wird gestartet, läuft oder angehalten.

Befehle

Öffnen Sie die Command Palette (Cmd+Shift+P / Ctrl+Shift+P) und geben Sie „Jamdesk“ ein, um auf Folgendes zuzugreifen:

BefehlBeschreibung
Jamdesk: Start Dev ServerDev-Server starten
Jamdesk: Stop Dev ServerLaufenden Server stoppen
Jamdesk: Restart Dev ServerServer neu starten
Jamdesk: Show OutputCLI-Ausgabekanal anzeigen

Einstellungen

Konfigurieren Sie die Erweiterung in den VS-Code-Einstellungen (Cmd+, / Ctrl+,) unter Jamdesk:

EinstellungStandardBeschreibung
jamdesk.port3000Bevorzugter Port des Dev-Servers
jamdesk.verbosefalseAusführliche CLI-Ausgabe aktivieren
jamdesk.cleanfalseBuild-Cache beim nächsten Start leeren
jamdesk.browserModeexternalOrt zum Öffnen der Vorschau: external (Systembrowser) oder embedded (VS-Code-Seitenleiste)
jamdesk.autoOpenBrowsertrueBrowser öffnen, sobald der Server bereit ist

Setzen Sie browserMode auf embedded, um die Dokumentationsvorschau in einer VS-Code-Seitenleiste zu öffnen. So können Sie Dokumentation bearbeiten und Vorschau nebeneinander anzeigen, ohne zwischen Fenstern zu wechseln.

Intelligente Portverwaltung

Wenn der bevorzugte Port bereits verwendet wird, erhöht die CLI die Portnummer automatisch auf den nächsten verfügbaren Port. Die Erweiterung erkennt den tatsächlichen Port aus der CLI-Ausgabe, sodass der Browser immer die richtige URL öffnet.

Ausgabekanal

Die Erweiterung streamt die gesamte CLI-Ausgabe in einen dedizierten Jamdesk-Ausgabekanal. Öffnen Sie ihn mit dem Befehl Jamdesk: Show Output oder über das Dropdownmenü im Bereich Output.

Verwenden Sie ihn, um:

  • den Build-Fortschritt zu überwachen
  • Serverprobleme zu debuggen
  • ausführliche Protokolle anzuzeigen, wenn jamdesk.verbose aktiviert ist

Wie geht es weiter?

Lokale Vorschau

CLI-basierte Vorschau mit benutzerdefinierten Ports und ausführlichem Modus

CLI-Übersicht

Vollständige Referenz der CLI-Befehle