Tutorial de extremo a extremo
De un repositorio vacío a un sitio de docs en producción: crea un proyecto, previsualiza en local, despliega y configura un dominio personalizado si lo necesitas.
Ve de un repositorio vacío a un sitio de documentación en producción. Añade un dominio personalizado cuando lo necesites y omite cualquier paso que ya hayas completado.
Requisitos previos
- Una cuenta de GitHub
- Un repositorio con contenido de documentación (o usa el Starter Template)
- Node.js 20+ si quieres instalar la CLI con npm
Crea tu primer proyecto en el dashboard de Jamdesk y conecta un repositorio.
- Sigue Crear proyectos para configurar el nombre del proyecto, el slug y la ruta de la documentación
- Si se te solicita, instala la aplicación de GitHub y otorga acceso al repositorio (Conectar GitHub)
Usa la CLI de Jamdesk para previsualizar cambios en páginas antes de enviarlos a GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devTu preview local se ejecuta 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 se vea bien, publícalo con el flujo de Git del 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 con la rama configurada en tu proyecto si usas una rama diferente.
Cuando finalice el build, tu documentación estará disponible en your-project.jamdesk.app. Consulta Despliegue para más detalles.
Prepara tu documentación para producción con tu propio dominio cuando estés listo para usarlo 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 complete la verificación y el SSL
Para solución de problemas, consulta Dominios personalizados.
Validar el flujo de extremo a extremo
- Tu subdominio de Jamdesk carga y muestra el último build
- El preview local refleja el mismo contenido y navegación
- Si lo configuraste, 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 deseas la documentación en una subruta como example.com/docs, revisa Descripción general del despliegue y Alojamiento en subruta.