Usa la CLI para obtener una vista previa de la documentación de forma local, probar cambios en tiempo real y detectar problemas antes de implementar tu sitio de documentación.
Usa la CLI para obtener una vista previa de tu documentación de forma local mientras escribes y editas. Revisa los cambios en tiempo real antes de implementar, prueba la apariencia y funcionalidad de tu sitio de documentación y detecta problemas como enlaces rotos o problemas de accesibilidad.La CLI también incluye utilidades para mantener tu documentación, como comandos para cambiar el nombre de archivos, validar especificaciones de OpenAPI y migrar contenido entre formatos.
Para generar una vista previa local, ve a tu directorio de documentación (donde está el archivo docs.json) y ejecuta el siguiente comando:
Reportar código incorrecto
Copiar
Preguntar a la IA
mint dev
Una vista previa local de tu documentación está disponible en http://localhost:3000.Como alternativa, si no quieres instalar la CLI de forma global, puedes ejecutar un script de una sola vez:
De forma predeterminada, la CLI usa el puerto 3000. Puedes personalizar el puerto con la opción --port. Para ejecutar la CLI en el puerto 3333, por ejemplo, usa este comando:
Reportar código incorrecto
Copiar
Preguntar a la IA
mint dev --port 3333
Si intentas ejecutar en un puerto que ya está en uso, se usará el siguiente puerto disponible:
Reportar código incorrecto
Copiar
Preguntar a la IA
El puerto 3000 ya está en uso. Intentando el 3001.
Si tienes muchos archivos de OpenAPI, puedes omitir el procesamiento de estos archivos durante el desarrollo local para mejorar el rendimiento usando la opción --disable-openapi:
Si usas Autenticación parcial para restringir el acceso a tu documentación, puedes obtener una vista previa como un grupo de autenticación específico usando la opción --groups [groupname].Por ejemplo, si tienes un grupo llamado admin, puedes obtener una vista previa como miembro de ese grupo con el comando:
Para crear un proyecto de documentación nuevo, ejecuta el siguiente comando:
Reportar código incorrecto
Copiar
Preguntar a la IA
mint new [directorio]
Este comando clona el kit inicial en un directorio especificado. Si no se especifica un directorio, la herramienta CLI te pedirá crear un nuevo subdirectorio o sobrescribir el directorio actual.
Si sobrescribes el directorio actual, se eliminarán todos los archivos existentes en él.
La herramienta CLI te pedirá un nombre de proyecto y un tema para completar la configuración de tu proyecto.Puedes ejecutar mint new con las siguientes opciones:
--theme: Define el tema del nuevo proyecto.
--name: Define el nombre del nuevo proyecto.
--force: Sobrescribe el directorio actual si ya existe.
Por ejemplo, para crear un proyecto nuevo en el directorio docs con el nombre my-project y el tema linden, ejecuta el siguiente comando:
Identifica los enlaces internos rotos con el siguiente comando:
Reportar código incorrecto
Copiar
Preguntar a la IA
mint broken-links
El comando ignora los archivos que coinciden con los patrones definidos en .mintignore. Los enlaces que apuntan a archivos ignorados se reportan como rotos.
Migra las páginas de endpoints en MDX a páginas autogeneradas a partir de tu especificación de OpenAPI con el siguiente comando:
Reportar código incorrecto
Copiar
Preguntar a la IA
mint migrate-mdx
Este comando convierte páginas individuales de endpoints en MDX en páginas autogeneradas definidas en tu docs.json, mueve el contenido de MDX a la extensión x-mint en tu especificación de OpenAPI y actualiza tu navegación. Consulta Migración desde MDX para obtener información detallada.
Durante el desarrollo local, recomendamos usar extensiones en tu IDE para reconocer y dar formato a archivos MDX.Si usas Cursor, Windsurf o VS Code, recomendamos la extensión MDX para VS Code para el resaltado de sintaxis y Prettier para el formateo de código.Si usas JetBrains, recomendamos el plugin MDX para IntelliJ IDEA para el resaltado de sintaxis y configurar Prettier para el formateo de código.
Error: Could not load the "sharp" module using the darwin-arm64 runtime
Esto puede deberse a una versión desactualizada de Node. Prueba lo siguiente:
Desinstala la versión actualmente instalada de la CLI de mint: npm uninstall -g mint
Actualiza a Node.js.
Reinstala la CLI de mint: npm install -g mint
Problema: error desconocido
Solución: Ve al directorio raíz de tu usuario y elimina la carpeta ~/.mintlify. Después, ejecuta mint dev de nuevo.
Error: permiso denegado
Esto se debe a no tener los permisos necesarios para instalar paquetes de Node de forma global.Solución: Intenta ejecutar sudo npm i -g mint. Se te pedirá tu contraseña, la misma que usas para desbloquear tu computadora.
La vista previa local no se ve igual que mi documentación en la web
Es probable que se deba a una versión desactualizada de la CLI.Solución: Ejecuta mint update para obtener los cambios más recientes.
mintlify vs. paquete mint
Si tienes algún problema con el paquete de la CLI, primero ejecuta npm ls -g. Este comando muestra qué paquetes están instalados globalmente en tu máquina.Si no usas npm o no lo ves en la lista con -g, prueba which mint para localizar la instalación.Si tienes un paquete llamado mint y otro llamado mintlify instalado, debes desinstalar mintlify.
