Jamdesk Documentation logo

Estensione VS Code

Avvia, arresta e riavvia il server di sviluppo Jamdesk dalla barra di stato di Visual Studio Code, con controlli rapidi e anteprima automatica nel browser.

Visualizza in anteprima la documentazione senza uscire da Visual Studio Code. L'estensione Jamdesk aggiunge un pulsante alla barra di stato che avvia jamdesk dev, monitora il server e apre il browser quando è pronto. Non serve alcun terminale.

Prerequisiti

  • Jamdesk CLI installato (npm install -g jamdesk)
  • Un workspace contenente un file docs.json

Installare l'estensione

Cerca Jamdesk nel pannello Extensions di VS Code (Cmd+Shift+X su macOS, Ctrl+Shift+X su Windows/Linux) e fai clic su Install. In alternativa, installala direttamente dal VS Code Marketplace.

L'estensione si attiva automaticamente quando il workspace contiene un file docs.json. Nella barra di stato viene visualizzato un pulsante di riproduzione.

Avviare il server di sviluppo

Fai clic sul pulsante di riproduzione nella barra di stato per avviare il server di sviluppo. L'estensione:

  1. Avvia jamdesk dev come processo figlio
  2. Monitora l'output per rilevare quando il server è pronto
  3. Apre il browser sull'anteprima locale, se l'apertura automatica è abilitata

La barra di stato mostra lo stato attuale del server: in avvio, in esecuzione o arrestato.

Comandi

Apri la Command Palette (Cmd+Shift+P / Ctrl+Shift+P) e digita "Jamdesk" per accedere a:

ComandoDescrizione
Jamdesk: Start Dev ServerAvvia il server di sviluppo
Jamdesk: Stop Dev ServerArresta il server in esecuzione
Jamdesk: Restart Dev ServerRiavvia il server
Jamdesk: Show OutputMostra il canale di output della CLI

Impostazioni

Configura l'estensione nelle impostazioni di VS Code (Cmd+, / Ctrl+,), nella sezione Jamdesk:

ImpostazionePredefinitoDescrizione
jamdesk.port3000Porta preferita del server di sviluppo
jamdesk.verbosefalseAbilita l'output dettagliato della CLI
jamdesk.cleanfalseCancella la cache della build al prossimo avvio
jamdesk.browserModeexternalDove aprire l'anteprima: external (browser di sistema) o embedded (pannello laterale di VS Code)
jamdesk.autoOpenBrowsertrueApre il browser quando il server è pronto

Imposta browserMode su embedded per aprire l'anteprima della documentazione in un pannello laterale di VS Code. Puoi così modificare e visualizzare l'anteprima affiancate senza cambiare finestra.

Gestione intelligente delle porte

Se la porta preferita è già in uso, la CLI passa automaticamente alla porta disponibile successiva. L'estensione rileva la porta effettiva dall'output della CLI, così il browser viene sempre aperto sull'URL corretto.

Canale di output

L'estensione trasmette tutto l'output della CLI a un canale di output Jamdesk dedicato. Aprilo con il comando Jamdesk: Show Output o dal menu a discesa del pannello Output.

Usalo per:

  • Monitorare l'avanzamento della build
  • Eseguire il debug dei problemi del server
  • Visualizzare i log dettagliati, quando jamdesk.verbose è abilitato

Prossimi passi

Anteprima locale

Anteprima basata sulla CLI con porte personalizzate e modalità dettagliata

Panoramica della CLI

Riferimento completo dei comandi della CLI