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

Instalar la CLI de Mintlify

npm i -g mint
2

Previsualizar en local

En el directorio de documentación donde está docs.json, ejecuta:
mint dev
La previsualización estará disponible en http://localhost:3000.

​
Puertos personalizados

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

​
Versiones de Mintlify

Cada versión de la CLI corresponde a una versión concreta de Mintlify. Si la previsualización no coincide con producción, actualiza la CLI: 
npm mint update

​
Validar enlaces

Para detectar enlaces rotos: 
mint broken-links

​
Despliegue

Si el despliegue fue correcto, verás algo como:
Captura de un mensaje de despliegue: All checks have passed.

​
Formato de código

Recomendamos extensiones en el IDE para reconocer y formatear MDX. En VS Code: extensión MDX y Prettier.

​
Solución de problemas

Puede deberse a una versión antigua de Node. Prueba:
  1. Desinstalar la CLI: npm remove -g mint
  2. Actualizar a Node v19 o superior.
  3. Reinstalar: npm i -g mint
Solución: en la raíz del usuario, elimina la carpeta ~/.mintlify y ejecuta mint dev de nuevo.
¿Quieres ver los cambios recientes de la CLI? Consulta el changelog en npm.