Inicio rápido: Despliega en 5 minutos
Crea un sitio de documentación Jamdesk y despliégalo en tu subdominio. No se requieren herramientas de build—solo GitHub y dos archivos.
Despliega un sitio de documentación con solo dos archivos: docs.json y una página MDX.
Requisitos previos
Necesitarás:
- Una cuenta de GitHub
- Un repositorio con tu documentación (o crearemos uno)
Si estás migrando desde Mintlify u otra plataforma de documentación, consulta la Guía de migración.
Opción 1: Comenzar desde la plantilla inicial
La forma más rápida de empezar. La plantilla inicial incluye contenido de ejemplo, una especificación OpenAPI y ejemplos de cada componente para que puedas ver cómo funciona todo antes de reemplazarlo con tu propio contenido.
Ve a dashboard.jamdesk.com y regístrate con GitHub.
Haz clic en Nuevo proyecto → Desde plantilla → Starter Docs.
Jamdesk crea un repositorio de GitHub por ti con todo preconfigurado.
Tu documentación está desplegada en your-project.jamdesk.app. Edita los archivos MDX, haz push y el sitio se reconstruye automáticamente.
También puedes clonar el starter directamente: git clone https://github.com/jamdesk/starter-docs.git my-docs
Opción 2: Conectar un repositorio existente
¿Ya tienes un repositorio con documentación? Conéctalo directamente.
Ve a dashboard.jamdesk.com y regístrate con GitHub.
Haz clic en Nuevo proyecto y conecta tu repositorio.
- Selecciona tu repositorio de GitHub
- Elige la rama a desplegar
- Jamdesk detecta tu
docs.jsonautomáticamente
Tu documentación está desplegada en your-project.jamdesk.app con llms.txt generado automáticamente para que las herramientas de IA puedan leer tu documentación.
Cada push a tu rama conectada activa una reconstrucción automática.
Qué contiene un proyecto de documentación
Un proyecto Jamdesk mínimo tiene dos elementos:
my-docs/
├── docs.json # Configuration
└── introduction.mdx # Your first page
docs.json
El archivo de configuración que define tu sitio:
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}Páginas MDX
Páginas de documentación escritas en MDX:
---
title: Introduction
description: Welcome to the docs
---
# Welcome
This is your first documentation page.Desarrollo local (opcional)
El CLI de Jamdesk te permite hacer preview de los cambios localmente antes de hacer push a GitHub. Esto es útil para detectar errores de sintaxis MDX, pero no es obligatorio.
¿Prefieres no instalar nada? Omite esta sección. Edita tus archivos MDX, haz commit y push—tu documentación se construirá automáticamente.
Haz preview de los cambios localmente:
npm install -g jamdesk
cd my-docs
jamdesk devAbre http://localhost:3000 para ver tu documentación con recarga en caliente.
Añadir más páginas
- Crea un nuevo archivo MDX:
---
title: Getting Started
description: Learn the basics
---
Your content here...- Agrégalo a
docs.json:
{
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction", "getting-started"]
}
]
}
}- Haz push a GitHub: tu nueva página se despliega automáticamente.
Dominio personalizado
Añade tu propio dominio en Configuración → Dominios:
- Ingresa tu dominio (por ejemplo,
docs.example.com) - Añade los registros DNS que se muestran
- Espera la verificación (hasta 48 horas)
Los certificados SSL se aprovisionan automáticamente. Guía completa →