Exportación a PDF
Exporta todo tu sitio de documentación como un único PDF. Descargable desde el dashboard y enviado por correo electrónico. Solo para 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 por correo electrónico un enlace de descarga cuando está listo, y mantiene el PDF disponible para volver a descargar hasta tu próximo build de documentación.
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, en instalaciones seguras o en sitios de clientes
- Instantáneas de cumplimiento y auditoría en un commit específico
- Paquetes de entrega al cliente
Quién puede usarlo
La exportación a PDF está disponible en todos los planes de pago. Sin complementos, sin cargos adicionales. Los proyectos en prueba gratuita ven el botón pero no pueden ejecutar una exportación hasta que actualicen su plan.
Generar un PDF
En el dashboard, selecciona el proyecto desde la barra lateral, haz clic en Settings y desplázate hasta la sección PDF Exports debajo de los metadatos del proyecto.
El botón cambia a Generating… mientras Jamdesk renderiza el sitio en un navegador sin cabeza y escribe el PDF en el almacenamiento. El tiempo de finalización escala con la cantidad de páginas y el contenido de imágenes que tienen. La mayoría de los sitios se completan en pocos minutos.
Cuando el PDF esté listo, enviamos al usuario que inició sesión un correo electrónico con un enlace de regreso a la página de Settings. También puedes simplemente dejar la página abierta; el estado se actualiza en vivo.
Haz clic en Download PDF. Consulta Duración del enlace de descarga si el enlace expira en algún momento.
Proyectos multilingüe
Si tu docs.json tiene más de un idioma configurado, aparece un menú desplegable de configuración regional junto al botón Generate PDF.
{
"navigation": {
"languages": [
{ "language": "en", "default": true },
{ "language": "es" },
{ "language": "fr" }
]
}
}Cada exportación cubre un solo idioma. Para enviar los tres a un revisor, selecciona en, exporta, luego es, exporta, luego fr.
El idioma predeterminado se exporta en las URL raíz de tu sitio (por ejemplo, <slug>.jamdesk.app/getting-started, o tu dominio personalizado). Otras configuraciones regionales se exportan en sus URL con prefijo (por ejemplo, /es/getting-started).
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 la configuración regional que estás solicitando:
- Mismo build y configuración regional → 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 configuración regional diferente → se inicia un renderizado nuevo. 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 una segunda configuración regional 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 después de modificar tu documentación:
Envía tus cambios a GitHub, o usa jamdesk deploy desde el CLI.
La lista de Builds en el dashboard muestra Completed en el nuevo commit.
De regreso en la página de Settings, haz clic en Regenerate. Un nuevo build se ha completado desde la exportación en caché, por lo que Jamdesk inicia un renderizado nuevo.
Regenerate es seguro de usar con libertad. Si no se ha completado ningún nuevo build, no volverá a renderizar ni a enviar correos electrónicos.
Límite de velocidad
Puedes producir una exportación completada por proyecto cada cinco minutos. Las solicitudes dentro de esa ventana devuelven Try again in a few minutes. La ruta de aciertos de caché omite el límite de velocidad, por lo que las descargas repetidas de un PDF sin cambios nunca alcanzan ese límite.
Un PDF que lleva más de veinte minutos generándose se considera obsoleto. Puedes hacer clic en Generate PDF nuevamente para volver a encolarlo.
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 un lector visitaría (https://<slug>.jamdesk.app/<path>), por lo que todo lo que aparece en el navegador aparece en el PDF. Se permite que hasta el 10% de las páginas fallen en el renderizado; si se supera ese umbral, la exportación se interrumpe y puedes volver a intentarlo.
Sitios protegidos con contraseña
Si tu sitio está protegido con contraseña, el exportador de PDF no puede desbloquearlo. El navegador sin cabeza que realiza el renderizado no tiene sesión. Las páginas protegidas no aparecerán en el PDF y cuentan contra el presupuesto de fallos del 10% descrito anteriormente. Si la mayor parte de tu sitio está restringido, deshabilita la protección con contraseña antes de ejecutar la exportación, o confía solo en las páginas no protegidas.
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 regreso a la sección Settings → PDF Exports, además del recuento de páginas, la marca de tiempo y la configuración regional (para proyectos multilingüe). El propio dashboard también cambia al estado listo en vivo; no necesitas el correo electrónico para descargar.
Solo se envía correo electrónico al solicitante. Los demás colaboradores verán el nuevo PDF la próxima vez que abran la página de Settings.
Si el correo electrónico no llega en pocos minutos después de la finalización, revisa tu carpeta de spam. El PDF sigue disponible desde el dashboard independientemente de si el correo electrónico llega.
Duración del enlace de descarga
La URL de descarga en el dashboard y en el correo electrónico es una URL firmada de corta duración. Si devuelve un error 403, recarga la página de Settings. Jamdesk genera una URL nueva cada vez que la página consulta el estado de la exportación.
Solución de problemas
La función está temporalmente deshabilitada en toda la plataforma. Contacta con soporte.
La exportación a PDF renderiza un sitio compilado, no tu MDX fuente. Necesitas al menos un build exitoso en tu rama predeterminada. Envía un commit o haz clic en Rebuild en la página de Builds, espera a que finalice y luego inténtalo de nuevo.
Tu proyecto está en la prueba gratuita. Actualiza desde Settings → Billing.
Has alcanzado el límite de velocidad de cinco minutos. Espera y vuelve a intentarlo.
El PDF en caché fue reutilizado porque no se ha completado ningún nuevo build desde la última exportación. Envía un commit, o haz clic en Rebuild en la página de Builds, luego intenta Regenerate nuevamente una vez que el build finalice. 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 sin navegación), los enlaces externos y las páginas protegidas con contraseña no aparecerán. Los fallos de renderizado de páginas individuales se registran en la exportación. Si toda la exportación falla con Too many pages failed to render, verifica que las páginas afectadas se carguen correctamente en un navegador en <slug>.jamdesk.app.
Los diagramas grandes, los videos 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 imágenes en un 60-80%. Los videos se renderizan como un fotograma de póster con un ícono de reproducción, por lo que no aumentan el tamaño del archivo.