Tutorial completo
De un repositorio vacío a un sitio de documentación en vivo -- crea un proyecto, haz preview 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 y salta cualquier paso que ya hayas completado.
Requisitos previos
- Una cuenta de GitHub
- Un repositorio con contenido de documentación (o usa la Plantilla de inicio)
- Node.js 20+ si quieres instalar el CLI con npm
Crea tu primer proyecto en el dashboard de Jamdesk y conecta un repositorio.
- Sigue Creación de proyectos para definir el nombre del proyecto, el slug y la ruta de documentación
- Si se te solicita, instala la aplicación de GitHub y concede acceso al repositorio (Conectar GitHub)
Usa el CLI de Jamdesk para hacer preview de los cambios en las páginas antes de enviarlos a GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devTu preview local está disponible en http://localhost:3000. Más información en Preview local.
Abre una página .mdx en tu editor, guarda un cambio y actualiza el preview local. Cuando el resultado sea el esperado, publícalo con el flujo de Git del siguiente paso.
Cada push a tu rama configurada dispara 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 utilizas una rama diferente.
Cuando finalice el build, tu documentación estará en vivo en your-project.jamdesk.app. Consulta Despliegue para más detalles.
Deja tu documentación lista para producción con tu propio dominio cuando estés preparado para usarla fuera 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 completen la verificación y el SSL
Para resolución de problemas, consulta Dominios personalizados.
Valida el flujo completo
- 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 del autor
Opcional: Alojar en /docs
Si quieres la documentación en una subruta como example.com/docs, revisa Resumen de despliegue y Alojamiento en subruta.