Skip to main content
Requisito previo: Instala Node.js (versión 19 o superior) antes de continuar.
Sigue estos pasos para instalar y ejecutar Mintlify en tu sistema operativo: Paso 1: Instala Mintlify:
Paso 2: Navega al directorio de la documentación (donde se encuentra el archivo docs.json) y ejecuta el siguiente comando:
Una previsualización local de tu documentación estará disponible en http://localhost:3000.

​
Puertos personalizados

Por defecto, Mintlify usa el puerto 3000. Puedes personalizar el puerto en el que se ejecuta Mintlify usando la bandera --port. Para ejecutar Mintlify en el puerto 3333, por ejemplo, usa este comando:
Si intentas ejecutar Mintlify en un puerto que ya está en uso, usará el siguiente puerto disponible:

​
Versiones de Mintlify

Ten en cuenta que cada versión de la CLI está asociada a una versión específica de Mintlify. Si tu sitio local no coincide con la versión de producción, actualiza la CLI:

​
Validación de enlaces

La CLI puede ayudarte a validar los enlaces de referencia usados en tu documentación. Para identificar cualquier enlace roto, usa el siguiente comando:

​
Despliegue

Editores ilimitados disponibles en el Plan Pro y superiores.
Si el despliegue es exitoso, deberías ver lo siguiente:

​
Formateo de código

Sugerimos usar extensiones en tu IDE para reconocer y formatear MDX. Si eres usuario de VSCode, considera la extensión MDX para VSCode para el resaltado de sintaxis, y Prettier para el formateo de código.

​
Solución de problemas

Esto puede deberse a una versión desactualizada de node. Prueba lo siguiente:
  1. Elimina la versión de mintlify actualmente instalada: npm remove -g mintlify
  2. Actualiza a Node v19 o superior.
  3. Reinstala mintlify: npm install -g mintlify
Solución: Ve a la raíz de tu dispositivo y elimina la carpeta ~/.mintlify. Después, ejecuta mintlify dev de nuevo.
¿Tienes curiosidad por saber qué cambió en la versión de la CLI? Consulta el changelog de la CLI.