Saltar al contenido principal
Esta guía de inicio rápido te muestra cómo configurar y publicar tu sitio de documentación en minutos. Al completar esta guía, tendrás un sitio de documentación en producción listo para personalizar y ampliar.
Requisitos previos: Antes de comenzar, crea una cuenta y completa el onboarding.

​
Primeros pasos

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

​
Instala la Aplicación de GitHub

Mintlify ofrece una Aplicación de GitHub que automatiza la implementación cuando envías cambios a tu repositorio. Instala la Aplicación de GitHub siguiendo las instrucciones de la lista de verificación de onboarding o desde tu dashboard.
  1. Ve a Settings en tu Dashboard 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 la cuenta de usuario donde deseas instalar la aplicación.
  5. Selecciona los repositorios que deseas conectar.
Instalación de la GitHub App
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

Para trabajar localmente con tu documentación, instala la interfaz de línea de comandos (CLI), llamada mint, ejecutando este comando en tu terminal: 
npm i -g mint
Necesitas tener Node.js instalado en tu equipo. Si tienes problemas con la instalación, consulta la guía de solución de problemas.

​
Edita la documentación

Después de configurar tu entorno, puedes empezar a editar tus archivos de documentación. Por ejemplo, actualiza el título de la página de introducción:
  1. Abre el repositorio que creaste durante la configuración inicial.
  2. Abre index.mdx y ve al inicio 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"
---

​
Visualiza una vista previa de los cambios

Para ver una vista previa de los cambios en local, ejecuta el siguiente comando: 
mint dev
La vista previa estará 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 implementa las actualizaciones en tu sitio. Supervisa el estado de la implementación en el historial de confirmaciones de tu repositorio de GitHub o en el dashboard. Cuando la implementación se complete, tu actualización más reciente estará disponible en <your-project-name>.mintlify.app.

Ir a agregar un domain personalizado

Opcionalmente, omite el flujo del editor web y ve directamente a agregar un domain 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 dashboard.
  2. Selecciona Editor en la barra lateral izquierda.
Si no has instalado la Aplicación de GitHub, se te pedirá que la instales al abrir el editor web.
El editor web de Mintlify en modo editor visual

​
Edita la documentación

En el editor web, puedes navegar por los archivos de tu documentación desde la barra lateral. Vamos a actualizar la página de introducción: Busca y selecciona index.mdx en el explorador de archivos. Luego, en el editor, actualiza el campo title a “Hello World”.
Edición en el editor web
El editor incluye un completo conjunto 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 en 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.

​
Agregar 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 de producción. Para agregar un dominio personalizado, ve a la página de Domain Setup en tu dashboard.
Dominio personalizado
Ingresa tu dominio (por ejemplo, docs.yourcompany.com) y sigue las instrucciones proporcionadas para configurar los ajustes de DNS con tu proveedor de dominio.
Los cambios de DNS pueden tardar hasta 48 horas en propagarse, aunque a menudo se completan mucho antes.

​
Próximos pasos

¡Enhorabuena! Has desplegado correctamente tu sitio de documentación con Mintlify. Aquí tienes algunos próximos pasos para mejorar tu documentación:

Configura la configuración global

Configura el estilo a nivel de sitio, navigation, integrations y más con el archivo docs.json.

Personaliza tu tema

Aprende a personalizar colores, tipografías 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 Accordion, pestañas y ejemplos de código.

Configura referencias de API

Crea referencias de API interactivas con especificaciones OpenAPI y AsyncAPI.

​
Solución de problemas

Si tienes inconvenientes durante la configuración, revisa estas soluciones comunes:
Asegúrate de tener instalado Node.js v19+ y de ejecutar el comando mint dev desde el directorio que contiene tu archivo docs.json.
La implementación puede tardar algunos minutos. Revisa tus GitHub Actions (para un flujo de trabajo basado 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 de DNS estén configurados correctamente y espera el tiempo suficiente para la propagación de DNS (hasta 48 horas). Puedes usar herramientas como DNSChecker para verificar tu registro CNAME.
⌘I