Saltar al contenido principal

​
Requisitos previos

  • Node.js v20.17.0+ (se recomiendan versiones LTS)

​
Instalar la CLI

npm i -g mint

​
Crear un nuevo proyecto

Para crear un nuevo proyecto de documentación a partir de la plantilla inicial de Mintlify, ejecuta el siguiente comando: 
mint new [directory]
Si no especificas un directorio, la CLI te solicitará crear un nuevo subdirectorio o sobrescribir el directorio actual.
Sobrescribir el directorio actual elimina todos los archivos existentes.
FlagDescripción
--nameNombre del proyecto. La CLI lo solicita si no se proporciona.
--themeTema del proyecto. La CLI lo solicita si no se proporciona.
--forceSobrescribir el directorio actual sin solicitar confirmación.
En entornos no interactivos como pipelines de CI/CD o agentes de codificación IA, debes proporcionar los flags --name y --theme.

​
Actualizar

Si tu previsualización local no está sincronizada con la documentación desplegada, actualiza la CLI a la última versión: 
mint update
Si mint update no está disponible en tu versión, reinstala la CLI con la última versión: 
npm i -g mint@latest

​
Formato

Para resaltado de sintaxis y formato de código en archivos MDX, recomendamos usar las siguientes extensiones:

​
Solución de problemas

Esto puede deberse a una versión desactualizada de Node.js. Intenta lo siguiente:
  1. Elimina la versión actual de la CLI de mint: npm uninstall -g mint
  2. Actualiza a Node.js v20.17.0+.
  3. Reinstala la CLI de mint: npm install -g mint
Solución: Ve a la raíz de tu dispositivo y elimina la carpeta ~/.mintlify. Después, ejecuta mint dev nuevamente.
Esto se debe a que no tienes los permisos necesarios para instalar paquetes de Node de forma global.Solución: Intenta ejecutar sudo npm i -g mint. Cuando se te solicite, ingresa la contraseña que usas para desbloquear tu computadora.
Es probable que esto se deba a una versión desactualizada de la CLI.Solución: Ejecuta mint update para obtener los últimos cambios.
Si tienes problemas con el paquete de la CLI, primero ejecuta npm ls -g para ver qué paquetes están instalados globalmente. Si no usas npm, prueba which mint para localizar la instalación.Si tienes instalados tanto el paquete mint como el paquete mintlify, desinstala mintlify:
npm uninstall -g mintlify
npm cache clean --force
npm i -g mint
Si ejecutas mint version y la versión del cliente se muestra como none, es posible que la CLI no pueda descargar la aplicación cliente debido a un firewall corporativo o VPN.Solución: Pide a tu administrador de TI que agregue releases.mintlify.com a la lista de permitidos de tu red.

Temas relacionados

Mintlify CLIAutomatiza la documentación cuando el código cambiaGitHub