Crear un proyecto
Crea un proyecto de Jamdesk a partir de una plantilla o conecta un repositorio de GitHub. Tu sitio estará en línea en yourproject.jamdesk.app en minutos.
Antes de escribir cualquier documentación necesitas un proyecto. Puedes empezar desde una plantilla (Jamdesk crea el repositorio por ti, en GitHub o Bitbucket Cloud) o conectar un repositorio existente que ya tenga un docs.json. En cualquier caso, tendrás un sitio en línea 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 aplicación de GitHub de Jamdesk.
Desde el dashboard, haz clic en New Project en la esquina superior derecha.
Empieza con una plantilla prediseñada. Jamdesk crea un nuevo repositorio de GitHub para ti, con contenido de ejemplo, navegación y componentes ya configurados.
La plantilla inicial predeterminada incluye páginas de ejemplo, una especificación OpenAPI y ejemplos de todos los componentes. Reemplaza el contenido con el tuyo y listo.
Configura la información básica de tu proyecto:
| Campo | Descripción |
|---|---|
| Name | Nombre que se muestra en el dashboard |
| Slug | Identificador apto para URL (p. ej., 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"]
}
]
}
}Ajustes del proyecto
Después de crearlo, configura tu proyecto en Settings:
General
- Name - Actualiza el nombre que se muestra
- Slug - Cambia el identificador del proyecto
- Delete Project - Elimina el proyecto de forma permanente
Repositorio
- Branch - La rama que activa los despliegues
- Docs Path - Ubicación de
docs.jsonpara monorepos
Dominio
- Subdomain - Tu URL
*.jamdesk.app - Custom Domain - Añade tu propio dominio
- Host at a subpath - Sirve la documentación en una ruta como
/docso/helpen lugar de la raíz del sitio
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 aplicarse.
Límites del proyecto
El plan Pro incluye un proyecto. Agrega más con los complementos de proyecto a $15/mes cada uno.