Inicio Rápido: Despliega en 5 Minutos

Jamdesk es software de documentación que publica un repositorio de GitHub con Markdown como un sitio de documentación alojado, con salida legible por IA — llms.txt, endpoints .md por página y un servidor MCP — generada automáticamente.

Despliega un sitio de documentación con solo dos archivos: docs.json y una página MDX. Elige la ruta que se ajuste a tu punto de partida.

Requisitos Previos

Necesitarás:

• Una cuenta de GitHub
• Un repositorio con tu documentación (o crearemos uno)

Opción 1: Empieza desde la Plantilla de Inicio

La forma más rápida de comenzar. La plantilla de inicio incluye contenido de ejemplo, una especificación OpenAPI y ejemplos de cada componente para que puedas ver cómo funcionan las cosas antes de reemplazarlos con tu propio contenido.

Opción 2: Conecta un Repositorio Existente

¿Ya tienes un repositorio con documentación lista para Jamdesk? Conéctalo directamente. Si estás migrando desde Mintlify u otra plataforma de documentación, usa primero la Opción 3.

Opción 3: Migra desde Mintlify u Otra Documentación

¿Ya tienes documentación en Mintlify, GitBook, Docusaurus, ReadMe, Confluence u otra plataforma? Empieza con la guía de migración antes de crear un nuevo proyecto. Cubre el comando jamdesk migrate para Mintlify y los pasos manuales para otras herramientas de documentación. Después de la migración, conecta el repositorio migrado usando la Opción 2.

¿Qué hay en un Proyecto de Documentación?

Un proyecto mínimo de Jamdesk tiene dos cosas:

my-docs/
├── docs.json           # Configuration
└── introduction.mdx    # Your first page

Para sitios más grandes, consulta Estructura de Directorios para carpetas recomendadas, recursos y snippets.

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"]
      }
    ]
  }
}

Consulta la Referencia de docs.json para todas las opciones de configuración.

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.

Consulta MDX Básico para frontmatter, encabezados, enlaces y sintaxis de componentes.

Desarrollo Local

El CLI de Jamdesk te permite previsualizar cambios localmente antes de hacer push a GitHub. Esto es útil para detectar errores de sintaxis MDX antes de que lleguen a tu sitio en vivo. Para todos los métodos de instalación y comandos, consulta la descripción general del CLI de Jamdesk.

Previsualiza cambios localmente:

npm install -g jamdesk
cd my-docs
jamdesk dev

Abre http://localhost:3000 para ver tu documentación con recarga en caliente.

Añadir Más Páginas

1. Crea un nuevo archivo MDX:

---
title: Getting Started
description: Learn the basics
---

Your content here...

2. Añádelo a docs.json:

{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction", "getting-started"]
      }
    ]
  }
}

3. Haz push a GitHub: tu nueva página se despliega automáticamente.

Para más patrones de enlaces, incluyendo anclas y tarjetas, consulta Enlaces y Navegación.

Dominio Personalizado

Añade tu propio dominio en Configuración → Dominios:

1. Ingresa tu dominio (p. ej., docs.example.com)
2. Añade los registros DNS indicados
3. Espera la verificación (hasta 48 horas)

Los certificados SSL se provisionan automáticamente. Guía completa →

¿Necesitas Ayuda?

¿Atascado en algo? Explora el Centro de Ayuda para guías de configuración, facturación y resolución de problemas. O habla con una persona real: abre el widget de chat en la esquina inferior de cualquier página de Jamdesk, o escríbenos a support@jamdesk.com. Respondemos rápido.

Referencia Completa

Todo lo que puedes crear y ejecutar está en tres referencias: cada componente de MDX, cada comando de la CLI y cada opción de configuración de docs.json.

¿Qué Sigue?