Skip to main content
Requisitos:
  • Node.js 19 o superior
  • Un repositorio con un archivo docs.json
Sigue estos pasos para instalar y ejecutar Mintlify en tu sistema.
1

Instalar Mintlify CLI

npm i -g mint
2

Previsualizar en local

Navega a la carpeta de docs donde está tu docs.json y ejecuta:
mint dev
La vista previa local estará disponible en http://localhost:3000.

​
Puertos personalizados

Por defecto, Mintlify usa el puerto 3000. Puedes cambiarlo con --port. Por ejemplo, para usar el 3333: 
mint dev --port 3333
Si el puerto está ocupado, usará el siguiente disponible: 
Port 3000 is already in use. Trying 3001 instead.

​
Versiones de Mintlify

Cada release del CLI se asocia a una versión de Mintlify. Si la vista local no coincide con producción, actualiza el CLI: 
npm mint update
El CLI permite validar enlaces. Para detectar links rotos: 
mint broken-links

​
Deployment

Si el deployment es exitoso, deberías ver algo similar:
Screenshot of a deployment confirmation message that says All checks have passed.

​
Formato de código

Sugerimos extensiones para reconocer y formatear MDX. En VSCode puedes usar MDX VSCode extension y Prettier.

​
Troubleshooting

Esto puede deberse a una versión antigua de Node. Prueba lo siguiente:
  1. Elimina el CLI actual: npm remove -g mint
  2. Actualiza a Node v19 o superior.
  3. Reinstala el CLI: npm i -g mint
Solución: elimina la carpeta ~/.mintlify y ejecuta mint dev nuevamente.
¿Quieres ver cambios recientes del CLI? Revisa el changelog.