Instalar la CLI
Instala la CLI de Mintlify para previsualizar la documentación localmente, probar cambios en tiempo real y detectar errores antes de desplegar.
- Node.js v20.17.0+ (se recomiendan versiones LTS)
npm i -g mint¿Usas una herramienta de codificación con IA? Copia el siguiente prompt para que tu agente instale la CLI y verifique que funciona.
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.
| Flag | Descripción |
|---|---|
--name | Nombre del proyecto. La CLI lo solicita si no se proporciona. |
--theme | Tema del proyecto. La CLI lo solicita si no se proporciona. |
--template | Plantilla predefinida. La CLI la solicita si no se proporciona. |
--force | Sobrescribir el directorio actual sin solicitar confirmación. |
En modo interactivo, la CLI pregunta si deseas elegir un tema o clonar una plantilla. Para omitir el aviso, pasa el flag --template directamente:
mint new my-docs --template <template-name>Puedes combinar --template con --theme para anular el tema predeterminado de la plantilla:
mint new my-docs --template <template-name> --theme <theme>Consulta las plantillas disponibles en el repositorio mintlify/templates en GitHub. En modo interactivo, la CLI obtiene y muestra las plantillas disponibles automáticamente.
En entornos no interactivos como pipelines de CI/CD o agentes de codificación IA, debes proporcionar los flags --name y --theme, o el flag --template.
Si tu previsualización local no está sincronizada con la documentación desplegada, actualiza la CLI a la última versión:
mint updateSi mint update no está disponible en tu versión, reinstala la CLI con la última versión:
npm i -g mint@latestPara resaltado de sintaxis y formato de código en archivos MDX, recomendamos usar las siguientes extensiones:
- Cursor, Devin Desktop, VS Code: Extensión MDX para VS Code y Prettier
- JetBrains: Plugin MDX para IntelliJ IDEA y Prettier