Saltar al contenido principal

​
Empieza en tres pasos

Pon tu sitio de documentación en marcha en local y haz tu primera personalización.

​
Paso 1: Entorno local

Durante el onboarding creaste un repositorio en GitHub con el contenido si aún no tenías uno. Encontrarás el enlace en tu panel.Para clonar el repositorio y poder previsualizar cambios, sigue la guía Clonar un repositorio en la documentación de GitHub.
  1. Instala la CLI de Mintlify: npm i -g mint
  2. Ve al directorio de documentación y ejecuta: mint dev
  3. Abre http://localhost:3000 para ver la documentación en vivo.
La vista previa se actualiza automáticamente al editar archivos.

​
Paso 2: Despliega tus cambios

Instala la aplicación de Mintlify para GitHub desde tu panel.La app despliega automáticamente los cambios en tu sitio de documentación.
Como primer cambio, actualiza el nombre y los colores del sitio.
  1. Abre docs.json en tu editor.
  2. Cambia el campo "name" al nombre de tu proyecto.
  3. Actualiza "colors" para que coincidan con tu marca.
  4. Guarda y comprueba al instante en http://localhost:3000.
¡Prueba a cambiar el color primario para ver la diferencia de inmediato!

​
Paso 3: Publicar

  1. Haz commit y push de tus cambios.
  2. Tu documentación se actualizará y estará en línea en pocos momentos.

​
Próximos pasos

Con la documentación en marcha, explora estas funciones:

Escribir contenido

Aprende la sintaxis MDX y empieza a escribir.

Personalizar estilo

Adapta la documentación a tu marca.

Añadir ejemplos de código

Incluye bloques de código con resaltado de sintaxis.

Documentación de API

Genera documentación de API desde especificaciones OpenAPI.
¿Necesitas ayuda? Consulta la documentación completa o únete a la comunidad.