Crear un proyecto
Crea un proyecto de Jamdesk desde una plantilla o conecta un repositorio de GitHub existente. Tu sitio estará disponible en yourproject.jamdesk.app en minutos.
Antes de escribir cualquier documentación necesitas un proyecto. Puedes comenzar desde una plantilla (Jamdesk crea el repositorio de GitHub por ti) o conectar un repositorio existente que ya tenga un docs.json. De cualquier manera, tendrás un sitio en funcionamiento en pocos minutos.
Crear un nuevo proyecto
Ve a dashboard.jamdesk.com e inicia sesión con tu cuenta de GitHub.
Los usuarios que acceden por primera vez serán solicitados a autorizar la aplicación de GitHub de Jamdesk.
Desde el dashboard, haz clic en Nuevo proyecto en la esquina superior derecha.
Comienza con una plantilla prediseñada. Jamdesk crea un nuevo repositorio de GitHub para ti con contenido de muestra, navegación y componentes ya configurados.
La Plantilla inicial predeterminada incluye páginas de muestra, una especificación OpenAPI y ejemplos de cada componente — reemplaza el contenido con el tuyo y listo.
Define la información básica de tu proyecto:
| Campo | Descripción |
|---|---|
| Nombre | Nombre de visualización que aparece en el dashboard |
| Slug | Identificador compatible con URL (p. ej., my-docs) |
| Dominio | Tu subdominio *.jamdesk.app |
Estructura mínima del repositorio
Un proyecto de Jamdesk solo necesita un docs.json y al menos una página:
my-docs/
├── docs.json
└── introduction.mdx
Ejemplo de docs.json:
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}Ajustes del proyecto
Después de la creación, configura tu proyecto en Ajustes:
General
- Nombre - Actualiza el nombre de visualización
- Slug - Cambia el identificador del proyecto
- Eliminar proyecto - Elimina el proyecto de forma permanente
Repositorio
- Rama - Qué rama activa los despliegues
- Ruta de documentación - Ubicación de
docs.jsonpara monorepos
Dominio
- Subdominio - Tu URL
*.jamdesk.app - Dominio personalizado - Añade tu propio dominio
- Servir en /docs - Sirve la documentación en la ruta
/docsen lugar de la raíz
Build
- Mostrar marca Jamdesk - Muestra el enlace "Powered by Jamdesk" en tu pie de página (habilitado por defecto)
- Reconstruir - Activa manualmente un nuevo build
Los cambios en los ajustes de build requieren un nuevo build para que tengan efecto.
Límites de proyectos
| Plan | Proyectos | Builds/mes |
|---|---|---|
| Free | 1 | 100 |
| Pro | 10 | Ilimitado |
| Team | Ilimitado | Ilimitado |