Requisito previo: Por favor, instale Node.js (versión 19 o superior) antes de continuar.

Paso 1: Instale el CLI:

npm i -g mint

Paso 2: Navegue al directorio de documentos (donde se encuentra el archivo docs.json) y ejecute el siguiente comando:

mint dev

Alternativamente, si no desea instalar el CLI globalmente, puede usar un script de una sola vez:

npx mint dev

Una vista previa local de su documentación estará disponible en http://localhost:3000.

​
Actualizaciones

Cada versión del CLI está asociada con una versión específica de la plataforma Mintlify. Si su vista previa local no coincide con la versión de producción, actualice el CLI:

npm i -g mint@latest

​
Puertos personalizados

Por defecto, el CLI usa el puerto 3000. Puede personalizar el puerto usando la bandera --port. Para ejecutar el CLI en el puerto 3333, por ejemplo, use este comando:

mint dev --port 3333

Si intenta ejecutar en un puerto que ya está en uso, utilizará el siguiente puerto disponible:

Port 3000 is already in use. Trying 3001 instead.

​
Comandos adicionales

Aunque mint dev es el comando más comúnmente utilizado, hay otros comandos que puede usar para administrar su documentación.

​
Encontrar enlaces rotos

El CLI puede ayudar a validar los enlaces de referencia hechos en su documentación. Para identificar cualquier enlace roto, use el siguiente comando:

mint broken-links

​
Verificar especificación OpenAPI

Puede usar el CLI para verificar errores en su archivo OpenAPI usando el siguiente comando:

mint openapi-check <openapiFilenameOrUrl>

Puede pasar un nombre de archivo (por ejemplo, ./openapi.yaml) o una URL (por ejemplo, https://petstore3.swagger.io/api/v3/openapi.json).

​
Renombrar archivos

Puede renombrar archivos usando el siguiente comando:

mint rename <oldFilename> <newFilename>

Esto es una mejora sobre actualizar el nombre del archivo normalmente, ya que también actualizará todas las referencias al archivo, asegurando que no haya enlaces rotos.

​
Formato

Mientras desarrolla localmente, recomendamos usar extensiones en su IDE para reconocer y formatear MDX.

Si usa Cursor, Windsurf o VSCode, recomendamos la extensión MDX VSCode para resaltado de sintaxis, y Prettier para el formato de código.

Si usa JetBrains, recomendamos el plugin MDX IntelliJ IDEA para resaltado de sintaxis, y configuración de Prettier para el formato del código.

​
Solución de problemas