Qué es Mintlify Docs y Cómo Usarlo: Guía para Principiantes

Ashley Goolam

Ashley Goolam

4 June 2025

Qué es Mintlify Docs y Cómo Usarlo: Guía para Principiantes

¿Te cuesta crear documentación elegante y fácil de usar que no parezca una tarea tediosa? Saluda a Mintlify, la plataforma nativa de IA que hace que crear documentación impresionante sea tan fácil como escribir una entrada de blog. Con más de 28K estrellas en GitHub y clientes como Stripe, Mintlify ofrece funciones interactivas, herramientas de IA e integraciones perfectas para mejorar tu juego de documentación. En esta guía para principiantes, te guiaré a través de la instalación de Mintlify, la configuración de un dominio personalizado, el aprovechamiento de la ingesta de IA, la integración de un servidor MCP, la adición de traducciones y el uso de OpenAPI para la documentación de API. Ya seas desarrollador o líder de equipo, estarás enviando documentación de nivel profesional en poco tiempo. ¿Listo para hacer que la documentación sea divertida? ¡Vamos a sumergirnos!

💡
Antes de empezar, si buscas optimizar el desarrollo de tu API, Apidog ofrece una plataforma todo en uno para diseñar, probar y documentar APIs. Con su interfaz intuitiva y funciones robustas, es perfecta tanto para principiantes como para desarrolladores experimentados. Lo mejor de todo, ¡puedes empezar gratis! (apidog)
botón

¿Qué es Mintlify? Tu superpoder para la documentación

Mintlify es una plataforma de documentación moderna que ayuda a los desarrolladores a crear documentación hermosa, interactiva y optimizada para SEO con el mínimo esfuerzo. Construida para equipos y proyectos de código abierto, renderiza archivos Markdown y MDX en páginas responsivas, soporta integración con GitHub e incluye funciones impulsadas por IA como generación de código y traducciones. Las ventajas clave incluyen:

Con un flujo de trabajo de arrastrar y soltar y tasas de conversión de usuarios un 40% más altas, Mintlify es perfecta para startups o proyectos públicos. Vamos a configurarla

mintlify.com

Instalación y Configuración de Mintlify

Empezar con Mintlify es muy sencillo, y necesitarás Node.js, la CLI de Mintlify y una cuenta de GitHub. Así es como puedes empezar, basándote en la guía oficial.

1. Instalar Prerrequisitos:

2. Clonar el Kit de Inicio:

git clone https://github.com/mintlify/starter-kit
cd starter-kit

3. Instalar la CLI de Mintlify:

npm install -g mintlify-cli

4. Ejecutar la Vista Previa Local:

mintlify-cli dev

5. Editar tu Documentación:

{
  "name": "My Docs",
  "theme": "prism",
  "colors": { "primary": "#3498db" }
}

Lo configuré en menos de 10 minutos y tenía un sitio en vivo con mis ajustes, ¡súper fluido!

Configuración de un Dominio Personalizado para Mintlify

¿Quieres que tu documentación resida en docs.yourcompany.com en lugar de un subdominio de mintlify.app? Mintlify facilita los dominios personalizados.

1. Acceder a Configuración:

dominio personalizado

2. Añadir tu Dominio:

cname

3. Esperar la Propagación:

Configuré un dominio personalizado para un sitio de prueba, y estuvo en vivo en pocas horas, ¡sensación profesional total!

Aprovechando la Ingesta de IA con Mintlify

La ingesta de IA de Mintlify hace tu documentación más inteligente y accesible, permitiendo a los usuarios buscar contenido mediante consultas impulsadas por IA.

1. Habilitar la Ingesta de IA:

chat de ia

2. Probar la Búsqueda de IA:

3. Mejorar con Correcciones de IA:

Probé la búsqueda de IA en un sitio de ejemplo, y encontró mi documentación de API al instante, ¡mucho más rápido que la navegación manual!

Integración de un Servidor MCP con Mintlify

El Protocolo de Contexto del Modelo (MCP) permite que las aplicaciones de IA interactúen con tu documentación o APIs. Mintlify genera un servidor MCP para conectar tu contenido con los LLMs.

1. Instalar la CLI de MCP:

npm i @mintlify/mcp

2. Configurar el Servidor MCP:

3. Usar el Servidor MCP:

Instalación Local del Servidor MCP de Mintlify

Para ejecutar el servidor MCP de Mintlify en tu máquina:

npx @mintlify/mcp add mintlify
instalar mintlify localmente

Ejemplo: Usé Windsurf, y la terminal me mostró:

node C:\User\Me.mcp\mintlify\src\index.js
comando mcp

Ejemplo de Consulta (en Windsurf):

Write a help doc about this feature based on this PRD, in the style and tone of AppleDB docs.

O, para formato compatible con Mintlify:

Write this in markdown using Mintlify components like anchors.
ejecutar en cliente mcp

Configuré un servidor MCP, y permitió que mi asistente de IA consultara mi documentación como un profesional, ¡cosas futuristas!

Añadir Traducciones a la Documentación de Mintlify

¿Quieres tu documentación en varios idiomas? Las traducciones impulsadas por IA de Mintlify facilitan la localización.

1. Habilitar Traducciones:

traducción mintlify

2. Personalizar Traducciones:

3. Probar la Traducción:

cambiar entre idiomas

Añadí traducciones al español, y mi documentación estuvo lista para ser global en minutos, ¡una gran victoria para la accesibilidad!

ver todos los idiomas

Usando Mintlify con VS Code

¿Documentando código en VS Code? ¡La extensión de Mintlify lo hace muy fácil!

1. Instalar la Extensión de Mintlify:

extensión mintlify vs code

2. Generar Documentación:

Código de Ejemplo:

test("@e2e wait for api response", async ({ page }) => {
  const sidemenuPage = new SideMenuPage(page);
  await sidemenuPage.interceptApiLink.click();
  const response = await page.waitForResponse((response) =>
    response.url().includes("/comments")
  );
  expect(response.status()).toBe(200);
  await page.getByText("CREATE post").isVisible();
});

Documentación Generada:

El bloque de código es un caso de prueba que verifica si la respuesta de la API se recibe correctamente.
usar mintlify en vs code

Documenté un script de prueba, y Mintlify acertó con la descripción, ¡sin esfuerzo!

Explorando las Funciones de Mintlify

Mintlify está repleta de herramientas para hacer que tu documentación brille. Así es como puedes mejorar:

Ajusté mi tema y añadí pestañas, ¡haciendo que mi documentación pareciera un diseño profesional en menos de una hora!

Conclusión: Tu Viaje con Mintlify Comienza

¡Excelente trabajo! Has desbloqueado el poder de Mintlify para crear documentación impresionante y lista para IA. Desde la instalación de la CLI hasta la configuración de dominios personalizados, ingesta de IA, servidores MCP, traducciones y entornos de prueba de OpenAPI, estás listo para construir documentación que cautive a los usuarios. ¡Experimenta con nuevos componentes, añade más idiomas o documenta tus APIs con APIdog! ¡Feliz documentación!

botón

Practica el diseño de API en Apidog

Descubre una forma más fácil de construir y usar APIs