Inicio rápido

Publica tu documentación en minutos

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 la configuración inicial.

Primeros pasos

Después de completar el onboarding, tu sitio de documentación se despliega automáticamente en una URL única con este formato:

https://<your-project-name>.mintlify.app

Encuentra tu URL en la página Overview de tu dashboard.

La URL de tu sitio está disponible de inmediato. Usa esta URL para hacer pruebas y compartirla con tu equipo mientras configuras tu sitio de documentación.

Instalar la app de GitHub

Mintlify ofrece una app de GitHub que automatiza el despliegue cuando haces push de cambios a tu repositorio.

Instala la app de GitHub siguiendo las instrucciones de la lista de verificación de onboarding o desde tu panel.

1. Ve a Settings en tu panel de Mintlify.
2. Selecciona GitHub App en la barra lateral.
3. Selecciona Install GitHub App. Se abrirá una nueva pestaña con la página de instalación de la app de GitHub.
4. Selecciona la organización o la cuenta de usuario donde quieres instalar la app.
5. Selecciona los repositorios que quieres conectar.

Actualiza los permisos de la app de GitHub si mueves tu documentación a otro repositorio.

Autoriza tu cuenta de GitHub

1. Ve a Settings en tu panel de Mintlify.
2. Selecciona My Profile en la barra lateral.
3. Selecciona Authorize GitHub account. Se abrirá una nueva pestaña con la página de autorización de GitHub.

Es posible que un administrador de tu organización de GitHub deba autorizar tu cuenta, según la configuración de tu 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 sus herramientas en el entorno local. Haz clic para ir a esta sección.

Flujo del editor web

Para quienes prefieren una interfaz visual en el 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 repositorios de Git existentes. Este flujo es ideal para equipos técnicos que desean gestionar la documentación junto con el código.

Instala 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

npm i -g mint

Necesitas tener Node.js instalado en tu equipo. Si encuentras problemas durante la instalación, consulta la guía de resolución de problemas.

Editar la documentación

Después de configurar tu entorno, puedes empezar a editar los archivos de tu documentación. Por ejemplo, actualiza el título de la página de introducción:

1. Abre el repositorio que se creó durante la incorporación.
2. Abre index.mdx y ve al inicio del archivo:

index.mdx

---
title: "Introduction"
description: "This is the introduction to the documentation"
---

3. Actualiza el campo title a "Hello World".

index.mdx

---
title: "Hello World"
description: "This is the introduction to the documentation"
---

Vista previa de los cambios

Para ver una vista previa de los cambios localmente, ejecuta el siguiente comando:

mint dev

La vista previa estará disponible en localhost:3000.

Envía los cambios

Cuando estés listo para publicar tus cambios, súbelos 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.

Cuando finalice el despliegue, la actualización más reciente estará disponible en <your-project-name>.mintlify.app.

Saltar a agregar un dominio personalizado

Opcionalmente, omite el flujo del Editor web y salta a agregar un dominio personalizado.

Flujo de trabajo del Editor web

El flujo de trabajo del Editor web ofrece una interfaz WYSIWYG (lo que ves es lo que obtienes) para crear y editar documentación. Este flujo es ideal para quienes prefieren trabajar en su navegador, 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 app de GitHub, se te pedirá que la instales al abrir el editor web.

Edita 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”.

El editor ofrece un conjunto completo de herramientas de formato y Componentes (Mintlify). 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 implementan de inmediato en tu sitio de documentación.

Usa ramas para previsualizar y revisar cambios mediante pull requests antes de implementarlos en tu sitio en producción.

Para más detalles sobre el uso del editor web, incluidas las ramas y los pull requests 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 prefieren usar un dominio personalizado para la documentación en producción.

Para añadir un dominio personalizado, ve a la página de Configuración de dominio en tu panel.

Introduce tu dominio (por ejemplo, docs.yourcompany.com) y sigue las instrucciones indicadas para configurar la 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

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

Configura los ajustes globales

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

Personaliza el 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 (Mintlify) interactivos como acordeones, pestañas y ejemplos de código.

Configura las 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 comunes:

La vista previa local no funciona

Asegúrate de tener Node.js v19+ instalado y de ejecutar el comando mint dev desde el directorio que contiene tu archivo docs.json.

Los cambios no se reflejan en el sitio en producción

El despliegue puede tardar varios minutos. Revisa tus GitHub Actions (para flujos de trabajo basados en código) o los registros de despliegue en el panel de Mintlify para asegurarte de que no haya errores de compilación.

El dominio personalizado no se conecta

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.