Jamdesk Documentation logo

VS Code-Erweiterung

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

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

Voraussetzungen

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

Erweiterung installieren

Suchen Sie im Bereich Erweiterungen von VS Code nach Jamdesk (Cmd+Shift+X unter macOS, Ctrl+Shift+X unter Windows/Linux) und klicken Sie auf Install. Alternativ installieren Sie sie über den VS Code Marketplace.

Die Erweiterung wird in einem Workspace aktiviert, der eine Datei docs.json enthält. In der Statusleiste erscheint eine Play-Schaltfläche.

Dev-Server starten

Klicken Sie in der Statusleiste auf die Play-Schaltfläche. 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 Serverzustand an: starting, running oder stopped.

Befehle

Öffnen Sie die Befehlspalette (Cmd+Shift+P / Ctrl+Shift+P) und geben Sie „Jamdesk“ ein:

BefehlBeschreibung
Jamdesk: Start Dev ServerDev-Server starten
Jamdesk: Stop Dev ServerLaufenden Server stoppen
Jamdesk: Restart Dev ServerServer neu starten
Jamdesk: Show OutputAusgabekanal der CLI anzeigen

Einstellungen

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

EinstellungStandardBeschreibung
jamdesk.port3000Bevorzugter Port für den Dev-Server
jamdesk.verbosefalseAusführliche CLI-Ausgabe aktivieren
jamdesk.cleanfalseBuild-Cache beim nächsten Start leeren
jamdesk.browserModeexternalOrt der Vorschau: external (System-Browser) oder embedded (Seitenleiste von VS Code)
jamdesk.autoOpenBrowsertrueBrowser öffnen, sobald der Server bereit ist

Setzen Sie browserMode auf embedded, um die Dokumentationsvorschau in der Seitenleiste von VS Code zu öffnen. So können Sie nebeneinander bearbeiten und die Vorschau sehen.

Intelligente Portverwaltung

Die CLI wechselt zum nächsten freien Port, wenn Ihr bevorzugter Port belegt ist. Die Erweiterung liest den Port aus der CLI-Ausgabe. Der Browser öffnet die richtige URL.

Ausgabekanal

Die Erweiterung streamt die CLI-Ausgabe in einen Ausgabekanal Jamdesk. Öffnen Sie ihn über den Befehl Jamdesk: Show Output oder über das Dropdown-Menü im Bereich Ausgabe.

Damit können Sie:

  • Den Fortschritt des Builds überwachen
  • Serverprobleme debuggen
  • Ausführliche Protokolle ansehen (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