Jamdesk Documentation logo

Anteprima locale

Visualizza in anteprima la documentazione sul tuo computer con la CLI di Jamdesk prima di pubblicare in produzione. Le modifiche appaiono mentre modifichi.

Esegui jamdesk dev (o npx jamdesk dev) da una directory che contiene un docs.json. Avvia un server locale con hot reload e ricerca. I componenti vengono visualizzati come in produzione.

Prerequisiti

  • Node.js 22.18+ o 24.11+ - Verifica con node --version
  • Un progetto di documentazione - Con un file di configurazione docs.json

Avvio del server di sviluppo

Installa la CLI globalmente, poi esegui dalla tua directory della documentazione:

npm install -g jamdesk
cd your-docs
jamdesk dev

La tua documentazione sarà disponibile su http://localhost:3000

Funzionalità disponibili

Hot Reload

Modifica i file MDX e vedi le modifiche all'istante. Le modifiche a docs.json e al tuo style.css vengono mostrate al refresh.

Ricerca completa

Testa la ricerca Cmd+K con i tuoi contenuti

Tutti i componenti

I componenti vengono visualizzati come in produzione

Cambio tema

Cambia il tema dei colori

Porta personalizzata

La porta predefinita è 3000. Passane una diversa con --port:

jamdesk dev --port 3001

Oppure imposta un valore predefinito permanente in ~/.jamdeskrc:

{
  "defaultPort": 3001
}

Modalità dettagliata

Mostra i dettagli della build con il flag --verbose:

jamdesk dev --verbose

Questo mostra:

  • Rilevamento delle modifiche ai file
  • Tempi di build
  • Analisi della navigazione
  • Eventuali avvisi o errori

Prestazioni al primo avvio

Il primo avvio di jamdesk dev installa le dipendenze in ~/.jamdesk. Richiede da 30 a 60 secondi. Gli avvii successivi partono in meno di 5 secondi.

Pulisci la cache e forza una nuova installazione:

jamdesk clean
jamdesk dev

Risoluzione dei problemi

Un altro processo sta usando la porta 3000.

Opzione 1: Usa una porta diversa

jamdesk dev --port 3001

Opzione 2: Trova e interrompi il processo

lsof -i :3000
kill -9 <PID>

Esegui il comando dalla directory che contiene il file docs.json:

ls docs.json  # Should show the file
jamdesk dev
  1. Controlla il terminale per eventuali errori
  2. Esegui un refresh forzato del browser (Cmd+Shift+R)
  3. Riavvia il server di sviluppo
  4. Esegui jamdesk clean e riprova

Esegui la diagnostica:

jamdesk doctor

Verifica l'ambiente e segnala eventuali problemi.

Prossimi passi

Estensione VS Code

Avvia il server di sviluppo dalla barra di stato di VS Code

Deployment

Scopri il processo di build e deploy