Crear un proyecto
Crea un proyecto de Jamdesk desde una plantilla o conectando un repositorio de GitHub. Tu sitio estará en vivo en yourproject.jamdesk.app en minutos.
Antes de escribir cualquier documentación necesitas un proyecto. Puedes empezar desde una plantilla (Jamdesk crea el repositorio de GitHub por ti) o conectar un repositorio existente que ya tenga un docs.json. De cualquier forma, tendrás un sitio en vivo en pocos minutos.
Crear un nuevo proyecto
Ve a dashboard.jamdesk.com e inicia sesión con tu cuenta de GitHub.
A los usuarios nuevos se les pedirá que autoricen la Jamdesk GitHub App.
Desde el dashboard, haz clic en New Project en la esquina superior derecha.
Comienza con una plantilla preconstruida. Jamdesk crea un nuevo repositorio de GitHub para ti con contenido de muestra, navegación y componentes ya configurados.
La Starter Template 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 |
|---|---|
| Name | Nombre visible que se muestra en el dashboard |
| Slug | Identificador amigable para URL (por ejemplo, my-docs) |
| Domain | 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.mdxEjemplo de docs.json:
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}Configuración del proyecto
Después de la creación, configura tu proyecto en Settings:
General
- Name - Actualiza el nombre visible
- Slug - Cambia el identificador del proyecto
- Delete Project - Elimina el proyecto de forma permanente
Repository
- Branch - Qué rama activa los despliegues
- Docs Path - Ubicación de
docs.jsonpara monorepos
Domain
- Subdomain - Tu URL
*.jamdesk.app - Custom Domain - Agrega tu propio dominio
- Host at /docs - Sirve la documentación en la ruta
/docsen lugar de la raíz
Build
- Show Jamdesk Branding - Muestra el enlace "Powered by Jamdesk" en tu pie de página (activado por defecto)
- Rebuild - Activa manualmente un nuevo build
Los cambios en los ajustes de build requieren un nuevo build para surtir efecto.
Límites de proyectos
| Plan | Proyectos | Builds/mes |
|---|---|---|
| Free | 1 | 100 |
| Pro | 10 | Ilimitados |
| Team | Ilimitados | Ilimitados |