Jamdesk Documentation logo

Exportación a PDF

Exporta tu sitio de documentación completo como un único PDF. Descargable desde el dashboard y entregado por correo electrónico. Solo en planes de pago.

Exporta tu sitio de documentación como un único PDF desde el dashboard. Jamdesk renderiza cada página publicada en un solo archivo, te envía un enlace de descarga por correo electrónico cuando está listo, y mantiene el PDF disponible para volver a descargarlo hasta el próximo build de tu documentación.

Descargar un PDF de muestra

Mira el aspecto de una exportación real. El sitio completo de documentación de Jamdesk, renderizado a través de este mismo pipeline. 408 páginas, 6.6 MB.

La exportación a PDF es útil para:

  • Compartir documentación con revisores que no tienen acceso al dashboard
  • Lectura sin conexión en aviones, instalaciones seguras o sitios de clientes
  • Instantáneas de cumplimiento normativo y auditoría en un commit específico
  • Paquetes de entrega a clientes

Quién puede usarlo

La exportación a PDF está incluida en todos los planes de pago sin cargo adicional, y no hay ningún complemento que comprar. Cada proyecto puede generar hasta 3 PDFs por día, con el contador reiniciándose a medianoche UTC.

Generar un PDF

1
Abrir Configuración → Exportaciones PDF

En el dashboard, selecciona el proyecto en la barra lateral, haz clic en Settings y desplázate hasta la sección PDF Exports bajo los metadatos del proyecto.

2
Hacer clic en Generate PDF

El botón cambia a Generating… mientras Jamdesk renderiza el sitio en un navegador sin interfaz gráfica y escribe el PDF en el almacenamiento. El tiempo de finalización escala con el número de páginas y la cantidad de imágenes que contienen. La mayoría de los sitios terminan en pocos minutos.

3
Esperar el correo electrónico

Cuando el PDF esté listo, enviamos al usuario con sesión iniciada un correo electrónico con un enlace de vuelta a la página de Settings. También puedes dejar la página abierta; el estado se actualiza en tiempo real.

4
Descargar

Haz clic en Download PDF. Consulta Duración del enlace de descarga si el enlace alguna vez expira.

Proyectos multilingüe

Si tu docs.json tiene más de un idioma configurado, aparece un selector de idioma junto al botón Generate PDF.

docs.json
{
  "navigation": {
    "languages": [
      { "language": "en", "default": true },
      { "language": "es" },
      { "language": "fr" }
    ]
  }
}

Cada exportación cubre un único idioma. Para enviar los tres a un revisor, selecciona en, exporta, luego es, exporta, luego fr.

Caché y Regenerar

La página de Settings recuerda solo la exportación completada más reciente por proyecto. Cuando haces clic en Regenerate, Jamdesk verifica si la última exportación coincide tanto con el build actual como con el idioma que estás solicitando:

  • Mismo build e idioma → el PDF en caché se devuelve inmediatamente. Verás un aviso que explica que nada ha cambiado desde tu última exportación.
  • Nuevo build o idioma diferente → se inicia un nuevo renderizado. Hacer clic en Rebuild cuenta como un nuevo build, incluso cuando el commit no ha cambiado.

Dado que la caché es un único espacio, exportar un segundo idioma o un nuevo build reemplaza lo que había antes. El PDF anterior no se elimina, pero ya no es el que aparece en la página de Settings.

Para obtener un PDF actualizado tras modificar tu documentación:

1
Publicar el nuevo contenido

Sube tus cambios a GitHub o usa jamdesk deploy desde el CLI.

2
Esperar a que el build termine

La lista de Builds en el dashboard muestra Completed en el nuevo commit.

3
Regenerar

De vuelta en la página de Settings, haz clic en Regenerate. Se ha completado un nuevo build desde la exportación en caché, por lo que Jamdesk inicia un nuevo renderizado.

Es seguro hacer clic en Regenerate con confianza. Si no se ha completado ningún nuevo build, no volverá a renderizar ni a enviar correo electrónico.

Límites de frecuencia

Cada proyecto tiene dos límites:

  • 3 exportaciones completadas por día. El contador se reinicia a medianoche UTC. El dashboard muestra cuántas has utilizado.
  • 5 minutos entre exportaciones. Las solicitudes dentro de esa ventana devuelven Try again in a few minutes.

Los aciertos de caché (mismo build e idioma que la exportación anterior) evitan ambos límites, por lo que las descargas repetidas de un PDF sin cambios nunca alcanzan el tope.

Un PDF que lleve más de veinte minutos generándose se considera obsoleto. Puedes hacer clic en Generate PDF de nuevo para volver a ponerlo en cola.

Qué se exporta

El PDF incluye cada página listada en la navegación de tu docs.json para el idioma elegido, en orden de declaración. Los enlaces externos en la navegación se omiten. Las páginas huérfanas (archivos en tu repositorio que no están conectados a la navegación) no se incluyen.

Cada página se renderiza a través de la misma URL que vería un lector (https://<slug>.jamdesk.app/<path>), por lo que todo lo que aparece en el navegador aparece en el PDF.

Sitios protegidos con contraseña

Si tu sitio está protegido con contraseña, no se generará un PDF. Desactiva la protección con contraseña para ejecutar la exportación y vuelve a activarla después.

Entrega por correo electrónico

Cuando el PDF está listo, la persona que hizo clic en Generate PDF recibe un correo electrónico con un enlace de vuelta a la sección Settings → PDF Exports, además del número de páginas, la marca de tiempo y el idioma (para proyectos multilingüe). El dashboard también cambia al estado listo en tiempo real; no necesitas el correo electrónico para descargar.

Solo se envía correo electrónico al solicitante. Los demás colaboradores ven el nuevo PDF la próxima vez que abren la página de Settings.

Si el correo electrónico no llega en unos minutos tras la finalización, revisa tu carpeta de spam. El PDF sigue disponible desde el dashboard independientemente de si el correo llega o no.

Duración del enlace de descarga

Los enlaces de descarga por correo electrónico son válidos durante 72 horas desde el momento en que el PDF finaliza. El dashboard genera una URL nueva cada vez que abres la página de Settings, por lo que las descargas desde el dashboard no caducan. Si un enlace de correo electrónico alguna vez devuelve un 403, ve al dashboard y haz clic en Download PDF desde allí.

Solución de problemas

La exportación a PDF renderiza un sitio ya construido, no tu MDX fuente. Necesitas al menos un build exitoso en tu rama predeterminada. Sube un commit o haz clic en Rebuild en la página de Builds, espera a que termine y vuelve a intentarlo.

Tu proyecto está en el período de prueba gratuito. Actualiza desde Settings → Billing.

Cada proyecto tiene un límite de 3 exportaciones completadas por día UTC. El contador se reinicia a medianoche UTC.

Has alcanzado el intervalo mínimo de cinco minutos entre exportaciones. Espera e inténtalo de nuevo.

El PDF en caché fue reutilizado porque no se ha completado ningún nuevo build desde la última exportación. Sube un commit o haz clic en Rebuild en la página de Builds, luego intenta Regenerate de nuevo una vez que el build termine. Consulta Caché y Regenerar.

El exportador solo extrae las páginas que están en la navegación de tu docs.json, en el idioma que seleccionaste. Las páginas huérfanas (creadas pero no incluidas en la navegación) y los enlaces externos no aparecerán. Verifica que las páginas faltantes se carguen correctamente en un navegador en <slug>.jamdesk.app.

Los diagramas grandes, los vídeos y las imágenes sin optimizar aumentan el tamaño del PDF rápidamente. Activa la Conversión Automática de Imágenes para reducir los bytes de imagen entre un 60-80%. Los vídeos se renderizan como un fotograma de póster con un icono de reproducción, por lo que no aumentan el tamaño del archivo.

¿Qué sigue?

Activar Builds

La exportación a PDF se ejecuta contra el build completado más reciente. Lánzalo manualmente o al hacer push.

Optimización de imágenes

Convierte PNG/JPG a WebP en el momento del build para mantener los PDFs pequeños.