Jamdesk Documentation logo

Tutorial de extremo a extremo

Desde un repositorio vacío hasta un sitio de documentación en producción con dominio personalizado -- crea un proyecto, previsualiza localmente, despliega y configura DNS.

Ve de un repositorio vacío a un sitio de documentación en producción con dominio personalizado. 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 deseas preview local
1
Crea un proyecto y conecta GitHub

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)
2
Preview local con la CLI

Usa la CLI de Jamdesk para previsualizar cambios antes de enviarlos a GitHub.

npm install -g jamdesk
cd your-docs
jamdesk dev

Tu preview local se ejecuta en http://localhost:3000. Más información en Preview local.

3
Despliega enviando cambios a GitHub

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 <your-branch>

Reemplaza <your-branch> con la rama configurada en tu proyecto (generalmente main).

Cuando finalice el build, tu documentación estará disponible en your-project.jamdesk.app. Consulta Despliegue para más detalles.

4
Añade un dominio personalizado

Prepara tu documentación para producción con tu propio dominio.

  1. Ve a SettingsDomains en el dashboard de Jamdesk
  2. Añade tu dominio (por ejemplo, docs.example.com)
  3. Crea los registros DNS que se muestran en el dashboard
  4. 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
  • 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.

¿Qué sigue?

Crear un proyecto

Gestiona la configuración del proyecto y las plantillas

Preview local

Trabaja más rápido con recarga en caliente

Descripción general del despliegue

Compara las opciones de alojamiento

Dominios personalizados

Verifica DNS y soluciona problemas de configuración