Guía rápida: Despliega en 5 minutos

Jamdesk es un software de documentación que publica un repositorio de GitHub con archivos 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 coincida con tu punto de partida.

Requisitos previos

Necesitarás:

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

Opción 1: Empezar desde la plantilla inicial

La forma más rápida de comenzar. La plantilla inicial incluye contenido de ejemplo, una especificación OpenAPI y ejemplos de todos los componentes para que puedas ver cómo funcionan antes de reemplazarlos con tu propio contenido.

Opción 2: Conectar 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: Migrar 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 proyecto nuevo. 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é contiene 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 conocer las carpetas, los assets y los snippets recomendados.

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 Bases de MDX para conocer el frontmatter, los encabezados, los enlaces y la sintaxis de componentes.

Desarrollo local

El CLI de Jamdesk te permite previsualizar los 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 producción. Para conocer todos los métodos de instalación y comandos, consulta la Descripción general del CLI de Jamdesk.

Previsualiza los 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, incluidos anclas y tarjetas, consulta Enlaces y navegación.

Dominio personalizado

Añade tu propio dominio en Settings → Domains:

1. Introduce tu dominio (por ejemplo, docs.example.com)
2. Añade los registros DNS mostrados
3. Espera la verificación (hasta 48 horas)

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

¿Necesitas ayuda?

¿Tienes algún problema? Consulta el Centro de ayuda para guías de configuración, facturación y solució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 del CLI y cada opción de configuración de docs.json.

¿Qué sigue?