Jamdesk Documentation logo

Anteprima locale

Visualizza la documentazione in locale con Jamdesk CLI prima della pubblicazione; le modifiche compaiono subito mentre lavori.

Esegui jamdesk dev (o npx jamdesk dev) da qualsiasi directory che contenga un docs.json per avviare un server locale con ricaricamento automatico, ricerca completa e tutti i componenti funzionanti esattamente come in produzione.

Prerequisiti

Prima di iniziare, assicurati di avere:

  • Node.js 20+ - Verifica con node --version
  • Un progetto docs - Con un file di configurazione docs.json

Avvio del server di sviluppo

Installa la CLI globalmente, quindi eseguila dalla directory della documentazione:

npm install -g jamdesk
cd your-docs
jamdesk dev

La documentazione sarà disponibile all'indirizzo http://localhost:3000

Funzionalità disponibili

Ricaricamento automatico

Modifica i file MDX e visualizza subito le modifiche. Le modifiche a docs.json e al tuo style.css vengono rilevate al refresh.

Ricerca completa

Prova la ricerca con Cmd+K usando i tuoi contenuti reali

Tutti i componenti

Ogni componente funziona esattamente come in produzione

Cambio del tema

Prova entrambe le modalità, chiara e scura

Porta personalizzata

La porta predefinita è 3000. Se è in uso, specificane un'altra:

jamdesk dev --port 3001

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

{
  "defaultPort": 3001
}

Modalità dettagliata

Visualizza informazioni dettagliate sul build con il flag --verbose:

jamdesk dev --verbose

Vengono mostrati:

  • Rilevamento delle modifiche ai file
  • Durata del build
  • Analisi della navigazione
  • Eventuali avvisi o errori

Prestazioni al primo avvio

La prima volta che esegui jamdesk dev, le dipendenze vengono installate in ~/.jamdesk. L'operazione richiede 30-60 secondi. Gli avvii successivi richiedono meno di 5 secondi.

Per svuotare la cache e forzare 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: Individua e arresta il processo

lsof -i :3000
kill -9 <PID>

Assicurati di trovarti nella directory che contiene il file docs.json:

ls docs.json  # Should show the file
jamdesk dev

Prova questi passaggi:

  1. Controlla la presenza di errori nel terminale
  2. Esegui un aggiornamento forzato del browser (Cmd+Shift+R)
  3. Riavvia il server di sviluppo
  4. Esegui jamdesk clean e riprova

Esegui la diagnostica:

jamdesk doctor

Questo comando controlla il tuo ambiente e identifica eventuali problemi.

Prossimi passi

Estensione VS Code

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

Distribuzione

Scopri il processo di build e distribuzione