Jamdesk Documentation logo

Tutorial de incorporación

Completa el flujo de incorporación guiado para configurar tu primer sitio de documentación — crea un proyecto, conecta GitHub, configura docs.json y activa tu primer build.

Los 5 pasos

1
Iniciar prueba

Cuando inicias sesión por primera vez, Jamdesk inicia automáticamente tu prueba gratuita de 14 días del plan Pro.

  • No se requiere tarjeta de crédito
  • Acceso completo a todas las funciones
  • La prueba termina 14 días después de la activación
2
Crear proyecto

Asigna un nombre a tu proyecto de documentación:

  • Usa un nombre claro y descriptivo (p. ej., "Documentación de la API", "Guía del usuario")
  • Esto forma parte de la URL de tu sitio de documentación
  • Puedes cambiar el nombre visible más tarde en la configuración del proyecto
3
Conectar GitHub y crear documentación inicial

Jamdesk crea un nuevo repositorio de GitHub a partir de la Plantilla inicial:

  • Páginas de ejemplo con contenido y componentes reales
  • docs.json preconfigurado con navegación y marca
  • Ejemplo de especificación OpenAPI para documentación de referencia de la API
  • Listo para editar y publicar de inmediato
4
Instalar CLI

El CLI de Jamdesk permite el desarrollo local:

npm install -g jamdesk

Puedes omitir este paso durante la incorporación e instalar el CLI en cualquier momento. Si lo omites, aún puedes editar la documentación directamente en GitHub.

5
Comenzar a editar

¡Ya estás listo para construir! Edita tu documentación:

  • Mediante CLI: Edita archivos localmente con jamdesk dev
  • Mediante GitHub: Edita archivos .mdx directamente en tu repositorio
  • En Jamdesk: Algunas funciones del dashboard están disponibles (según el plan)

Los cambios activan automáticamente rebuilds de la documentación cuando publicas en GitHub.

Después de la incorporación

Una vez que completes la incorporación, puedes:

Solución de problemas

Omití un paso, ¿puedo volver atrás?

Puedes completar la incorporación en cualquier momento desde el dashboard de tu proyecto. Busca la tarjeta de incorporación para continuar donde lo dejaste.

Elegí el repositorio de GitHub incorrecto

Crea un nuevo proyecto con el repositorio correcto — puedes eliminar el antiguo en cualquier momento.

Necesito ayuda durante la incorporación

Contacta con el soporte en cualquier momento del proceso.

Artículos relacionados

Primer build

Activa y verifica tu primer build

Tour del dashboard

Conoce el dashboard de Jamdesk