Tutorial de principio a fin
De un repositorio vacío a un sitio de documentación en vivo: crea un proyecto, previsualiza en local, despliega y configura un dominio personalizado.
Pasa de un repositorio vacío a un sitio de documentación en vivo. Añade un dominio personalizado cuando estés listo para desplegar y omite cualquier paso que ya hayas completado.
Requisitos previos
- Una cuenta de GitHub
- Un repositorio con contenido de documentación (o usa la Plantilla inicial)
- Node.js 20+ si quieres instalar la CLI con npm
Crea tu primer proyecto en el dashboard de Jamdesk y conecta un repositorio.
- Sigue Creación de proyectos para configurar el nombre del proyecto, el slug y la ruta de la documentación
- Si se te solicita, instala la GitHub App y concede acceso al repositorio (Conectar GitHub)
Usa la CLI de Jamdesk para previsualizar cambios en las páginas antes de subirlos a GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devTu preview local se ejecuta en http://localhost:3000. Aprende más en Preview local.
Abre una página .mdx en tu editor, guarda un cambio y actualiza el preview local. Cuando se vea bien, publícalo con el flujo de Git en el siguiente paso.
Cada push a tu rama configurada activa un build y publica en tu subdominio de Jamdesk.
git add .
git commit -m "Add docs content"
git push origin mainReemplaza main por la rama configurada en tu proyecto si usas una rama diferente.
Cuando el build termine, tu documentación estará en vivo en your-project.jamdesk.app. Consulta Despliegue para más detalles.
Sirve tu documentación desde tu propio dominio en lugar del subdominio de Jamdesk.
- Ve a Settings → Domains en el dashboard de Jamdesk
- Añade tu dominio (por ejemplo,
docs.example.com) - Crea los registros DNS que se muestran en el dashboard
- Espera a que se complete la verificación y el SSL
Para solución de problemas, consulta Dominios personalizados.
Valida el flujo de principio a fin
- Tu subdominio de Jamdesk carga y muestra el último build
- El preview local refleja el mismo contenido y navegación
- Si está configurado, el dominio personalizado está verificado y sirve HTTPS
- El historial de builds muestra el último commit y la atribución de autoría
Opcional: Alojar en /docs
Si quieres tu documentación en una subruta como example.com/docs, revisa Resumen de despliegue y Alojamiento en subruta.