Saltar al contenido principal
Después de completar esta guía, tendrás un sitio de documentación en línea listo para personalizar y ampliar.
Requisitos previos: Antes de comenzar, crea una cuenta y completa el proceso de configuración inicial.

​
Primeros pasos

Después de completar el proceso de configuración inicial, tu sitio de documentación se despliega automáticamente en una URL única con este formato: 
https://<nombre-de-tu-proyecto>.mintlify.app
Encuentra la URL de tu sitio en la página Overview de tu dashboard.
Dominio de Mintlify
La URL de tu sitio está disponible inmediatamente. Usa esta URL para hacer pruebas y compartirla con tu equipo mientras configuras tu sitio de documentación.

​
Instala la aplicación de GitHub

Mintlify proporciona una aplicación de GitHub que automatiza el despliegue cuando haces push de cambios a tu repositorio. Instala la aplicación de GitHub siguiendo las instrucciones de la lista de verificación de incorporación o desde tu panel.
  1. Navega a Settings en tu panel de Mintlify.
  2. Selecciona GitHub App en la barra lateral.
  3. Selecciona Install GitHub App. Esto abrirá una nueva pestaña con la página de instalación de la aplicación de GitHub.
  4. Selecciona la organización o cuenta de usuario donde quieres instalar la aplicación.
  5. Selecciona los repositorios que quieres conectar.
Instalación de la aplicación de GitHub
Actualiza los permisos de la aplicación de GitHub si mueves tu documentación a otro repositorio.

​
Autoriza tu cuenta de GitHub

  1. Ve a Settings en tu Dashboard de Mintlify.
  2. Selecciona My Profile en la barra lateral.
  3. Selecciona Authorize GitHub account. Esto abrirá una nueva pestaña con la página de autorización de GitHub.
Es posible que un administrador de tu organización en GitHub deba autorizar tu cuenta, según la configuración de la organización.

​
Flujos de edición

Mintlify ofrece dos flujos para crear y mantener tu documentación:

Flujo basado en código

Para quienes prefieren trabajar con herramientas existentes en su entorno local. Haz clic para ir a esta sección.

Flujo del editor web

Para quienes prefieren una interfaz visual en su navegador. Haz clic para ir a esta sección.

​
Flujo de trabajo basado en código

El flujo de trabajo basado en código se integra con tu entorno de desarrollo y con los repositorios de Git existentes. Este flujo es ideal para equipos técnicos que desean gestionar la documentación junto con el código.

​
Instalar la CLI

Requisito previo: La CLI requiere Node.js v20.17.0 o superior, hasta la v24. Se recomiendan las versiones LTS.
Para trabajar localmente con tu documentación, instala la interfaz de línea de comandos (CLI), llamada mint, ejecutando el siguiente comando en tu terminal: 
npm i -g mint

​
Crear un proyecto nuevo

Ejecuta mint new para crear un nuevo proyecto de documentación. Consulta la guía de instalación de la CLI para obtener detalles sobre el comando y sus flags.

​
Edita la documentación

Después de configurar tu proyecto, puedes empezar a editar los archivos de la documentación. Por ejemplo, actualiza el title de la página de introducción:
  1. Ve a tu repositorio de documentación.
  2. Abre index.mdx y ubica la parte superior del archivo:
index.mdx
---
title: "Introducción"
description: "Esta es la introducción a la documentación"
---
  1. Actualiza el campo title a "Hello World".
index.mdx
---
title: "Hola Mundo"
description: "Esta es la introducción a la documentación"
---

​
Vista previa de los cambios

Para ver una vista previa de los cambios en local, ejecuta el siguiente comando: 
mint dev
La vista previa está disponible en localhost:3000.
Mintlify Dev

​
Envía los cambios

Cuando estés listo para publicar tus cambios, envíalos a tu repositorio. Mintlify detecta automáticamente los cambios, compila tu documentación y despliega las actualizaciones en tu sitio. Supervisa el estado del despliegue en el historial de commits de tu repositorio de GitHub o en el panel. Después de que se complete el despliegue, tu actualización más reciente estará disponible en <your-project-name>.mintlify.app.

Saltar a agregar un dominio personalizado

Opcionalmente, omite el flujo de trabajo del editor web y pasa directamente a agregar un dominio personalizado.

​
Flujo de trabajo del editor web

El flujo de trabajo del editor web ofrece una interfaz WYSIWYG (what you see is what you get) para crear y editar documentación. Este flujo de trabajo es ideal para quienes prefieren trabajar en su navegador web sin herramientas de desarrollo locales adicionales.

​
Accede al editor web

  1. Inicia sesión en tu panel de control.
  2. Selecciona Editor en la barra lateral izquierda.
Si no has instalado la aplicación de GitHub, se te pedirá que la instales cuando abras el editor web.
El editor web de Mintlify en el modo editor visual

​
Editar la documentación

En el editor web, puedes navegar por los archivos de tu documentación desde la barra lateral. Actualicemos la página de introducción: Busca y selecciona index.mdx en el explorador de archivos. Luego, en el editor, actualiza el campo de título a “Hello World”.
Edición en el editor web
El editor proporciona un conjunto completo de herramientas de formato y componentes. Escribe /en el editor para abrir el menú de comandos y acceder a estas herramientas.

​
Publica tus cambios

Cuando estés conforme con tus ediciones, selecciona el botón Publish en la esquina superior derecha. Tus cambios se despliegan de inmediato en tu sitio de documentación.
Usa branches para previsualizar y revisar cambios mediante solicitudes de extracción antes de desplegar a tu sitio en producción.
Para más detalles sobre el uso del editor web, incluido el uso de branches y solicitudes de extracción para colaborar y previsualizar cambios, consulta nuestra documentación del editor web.

​
Añadir un dominio personalizado

Aunque tu subdominio <your-project-name>.mintlify.app funciona bien para pruebas y desarrollo, la mayoría de los equipos prefiere usar un dominio personalizado para la documentación en producción. Para añadir un dominio personalizado, ve a la página de Domain Setup en tu panel de control.
Dominio personalizado
Introduce tu dominio (por ejemplo, docs.yourcompany.com) y sigue las instrucciones proporcionadas para configurar la DNS con tu proveedor de dominios.
Los cambios de DNS pueden tardar hasta 48 horas en propagarse, aunque a menudo se completan mucho antes.

​
Próximos pasos

¡Felicidades! Has desplegado correctamente tu sitio de documentación con Mintlify. Estos son algunos próximos pasos sugeridos para mejorar tu documentación:

Configura los ajustes globales

Configura el estilo global del sitio, la navegación, las integraciones y más con el archivo docs.json.

Personaliza tu tema

Aprende cómo personalizar los colores, las fuentes y la apariencia general de tu sitio de documentación.

Organiza la navegación

Estructura tu documentación con una navegación intuitiva para ayudar a los usuarios a encontrar lo que necesitan.

Añade componentes interactivos

Mejora tu documentación con componentes interactivos como acordeones, pestañas y ejemplos de código.

Configura tus referencias de API

Crea referencias de API interactivas con especificaciones OpenAPI y AsyncAPI.

​
Solución de problemas

Si encuentras problemas durante el proceso de configuración, revisa estas soluciones a problemas frecuentes:
Asegúrate de tener instalado Node.js v20.17.0 o superior y de ejecutar el comando mint dev desde el directorio que contiene tu archivo docs.json.
La implementación puede tardar unos minutos. Revisa tus GitHub Actions (para flujos de trabajo basados en código) o los registros de implementación en el Dashboard de Mintlify para asegurarte de que no haya errores de compilación.
Verifica que tus registros DNS estén configurados correctamente y deja suficiente tiempo para la propagación de DNS (hasta 48 horas). Puedes usar herramientas como DNSChecker para verificar tu registro CNAME.