Inicio rápido
Comienza con Mintlify desplegando tu sitio de documentación en minutos y realizando tu primer cambio de contenido con el editor web o Git.
Después de completar esta guía, tendrás un sitio de documentación en línea listo para personalizar y actualizar.
¿Utilizas un agente de IA?
Copia el siguiente prompt para que tu agente configure el sitio por ti. Le indica a tu agente que cree tu cuenta y despliegue tu sitio. También añade la skill y el servidor MCP de Mintlify para obtener mejores resultados cuando actualices tu contenido.
El prompt divide el inicio rápido en tareas que tu agente puede completar y le indica que te pida cualquier información que necesite mientras lo configura todo.
Mintlify utiliza un enfoque de documentación como código para administrar tu documentación. Cada página de tu sitio tiene un archivo correspondiente almacenado en tu repositorio de documentación.
Cuando conectas tu repositorio de documentación a tu proyecto, puedes trabajar en tu documentación localmente o en el editor web y sincronizar cualquier cambio con tu repositorio remoto.
Ve a mintlify.com/start y completa el proceso de configuración inicial. Durante la configuración, conectarás tu cuenta de GitHub, crearás o seleccionarás un repositorio para tu documentación e instalarás la Aplicación de GitHub para habilitar las implementaciones automáticas.
Después de la configuración inicial, tu sitio de documentación se implementa y queda accesible en tu URL .mintlify.site.
Tu sitio de documentación ya se ha desplegado en https://<your-project-name>.mintlify.site.
Encuentra tu URL exacta en la página Overview de tu Dashboard de Mintlify.
Tu sitio ya está disponible para verse de inmediato. Usa esta URL para hacer pruebas y compartirla con tu equipo. Antes de compartirla con tus usuarios, quizá quieras añadir un dominio personalizado.
Instala la CLI
La CLI requiere Node.js v20.17.0 o superior. Usa una versión LTS para mayor estabilidad.
npm i -g mintConsulta Instalar la CLI para ver todos los detalles y la resolución de problemas.
Clona tu repositorio
Si aún no has clonado tu repositorio localmente, clónalo usando Git:
git clone <your-repository-url>Si tu repositorio está en la organización privada de Mintlify, consulta Clonar a tu propio repositorio para moverlo primero a tu cuenta.
Edita una página
Abre index.mdx en tu editor preferido y actualiza el campo description en el frontmatter:
---
title: "Introduction"
description: "Your custom description here"
---Vista previa local
Ejecuta el siguiente comando desde tu directorio de documentación:
mint devVe la vista previa en http://localhost:3000.
Haz push de tus cambios
Crea una confirmación (commit) y haz push de tus cambios para iniciar una implementación:
git add .
git commit -m "Update description"
git pushMintlify implementa automáticamente tus cambios. Consulta el estado de implementación en la página de Overview de tu dashboard.
Abre el editor web
Navega al editor web en tu dashboard.
Edita una página
Abre la página Introduction y actualiza la descripción.
Publicar
Haz clic en el botón Publish en la esquina superior derecha de la barra de herramientas del editor web.
Ver en vivo
En la página de Overview de tu dashboard, puedes ver el estado de implementación de tu sitio. Cuando la implementación haya finalizado, actualiza tu sitio de documentación para ver tus cambios en vivo.
Edita la documentación en tu navegador y obtén una vista previa de cómo se ven tus páginas al publicarlas.
Encuentra enlaces rotos, verifica la accesibilidad, valida especificaciones de OpenAPI y más.
Usa tu propio dominio para tu sitio de documentación.