Skip to main content

​
Comienza en tres pasos

Levanta tu sitio de documentación en local y aplica tu primera personalización.

​
Paso 1: Configura tu entorno local

En el onboarding creaste un repositorio con el contenido de tus docs. Puedes ver el enlace en tu dashboard.Para clonar el repositorio y previsualizar cambios, sigue la guía de GitHub sobre Clonar un repositorio.
  1. Instala el CLI de Mintlify: npm i -g mint
  2. Entra a tu carpeta de docs y ejecuta: mint dev
  3. Abre http://localhost:3000 para ver tus docs
El preview se actualiza automáticamente al editar.

​
Paso 2: Despliega tus cambios

Instala la app de GitHub de Mintlify desde tu dashboard.La app despliega automáticamente tus cambios en producción.
Para un primer cambio, edita el nombre y los colores de tu sitio.
  1. Abre docs.json en tu editor.
  2. Cambia el campo "name" al nombre del proyecto.
  3. Actualiza "colors" para que coincida con tu marca.
  4. Guarda y revisa los cambios en http://localhost:3000.
Try changing the primary color to see an immediate difference!

​
Paso 3: Publica

  1. Haz commit y push de tus cambios.
  2. Tus docs se publicarán en minutos.

​
Próximos pasos

Ahora que tus docs están corriendo, revisa estas funciones clave:

Escribe contenido

Aprende sintaxis MDX y escribe tu documentación.

Personaliza estilo

Ajusta colores y estilo para que coincida con tu marca.

Agrega ejemplos

Incluye bloques de código con resaltado.

Docs de API

Genera documentación desde OpenAPI.
¿Necesitas ayuda? Revisa la documentación oficial o únete a la comunidad.