Jamdesk Documentation logo

Preview Local

El CLI de Jamdesk te permite hacer preview de tu documentación en tu máquina antes de desplegar a producción. Los cambios aparecen al instante mientras editas.

Ejecuta jamdesk dev (o npx jamdesk dev) desde cualquier directorio que contenga un docs.json para iniciar un servidor local con recarga en caliente, búsqueda completa y todos los componentes funcionando exactamente igual que en producción.

Requisitos previos

Antes de comenzar, asegúrate de tener:

  • Node.js 20+ - Compruébalo con node --version
  • Un proyecto de documentación - Con un archivo de configuración docs.json

Iniciar el servidor de desarrollo

Instala el CLI de forma global y luego ejecútalo desde el directorio de tu documentación:

npm install -g jamdesk
cd your-docs
jamdesk dev

Tu documentación estará disponible en http://localhost:3000

Qué obtienes

Recarga en caliente

Edita archivos MDX y ve los cambios al instante. Los cambios de configuración en docs.json se recogen al actualizar.

Búsqueda completa

Prueba la búsqueda con Cmd+K con tu contenido real

Todos los componentes

Cada componente funciona exactamente igual que en producción

Cambio de tema

Prueba los modos claro y oscuro

Puerto personalizado

El puerto predeterminado es 3000. Si está en uso, especifica uno diferente:

jamdesk dev --port 3001

O establece un valor predeterminado permanente en ~/.jamdeskrc:

{
  "defaultPort": 3001
}

Modo detallado

Consulta información detallada del build con el indicador --verbose:

jamdesk dev --verbose

Esto muestra:

  • Detección de cambios en archivos
  • Tiempos de build
  • Análisis de navegación
  • Advertencias o errores

Rendimiento en la primera ejecución

La primera vez que ejecutes jamdesk dev, se instalan las dependencias en ~/.jamdesk. Esto tarda entre 30 y 60 segundos. Las ejecuciones posteriores arrancan en menos de 5 segundos.

Para limpiar la caché y forzar una instalación nueva:

jamdesk clean
jamdesk dev

Solución de problemas

Otro proceso está usando el puerto 3000.

Opción 1: Usa un puerto diferente

jamdesk dev --port 3001

Opción 2: Encuentra y detén el proceso

lsof -i :3000
kill -9 <PID>

Asegúrate de estar en el directorio que contiene tu archivo docs.json:

ls docs.json  # Should show the file
jamdesk dev

Prueba estos pasos:

  1. Comprueba el terminal en busca de errores
  2. Recarga forzada del navegador (Cmd+Shift+R)
  3. Reinicia el servidor de desarrollo
  4. Ejecuta jamdesk clean e inténtalo de nuevo

Ejecuta diagnósticos:

jamdesk doctor

Esto comprueba tu entorno e identifica problemas.

¿Qué sigue?

Extensión de VS Code

Inicia el servidor de desarrollo desde la barra de estado de VS Code

Despliegue

Aprende sobre el proceso de build y despliegue