mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
be2090200f
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
124 lines
4.4 KiB
Plaintext
124 lines
4.4 KiB
Plaintext
---
|
|
title: "Instalar la CLI"
|
|
description: "Instala la CLI de Mintlify para previsualizar la documentación localmente, probar cambios en tiempo real y detectar errores de compilación antes de desplegar en producción."
|
|
keywords: ["CLI", "npm", "instalar", "Node.js", "pnpm", "mint"]
|
|
---
|
|
|
|
<div id="prerequisites">
|
|
## Requisitos previos
|
|
</div>
|
|
|
|
- [Node.js](https://nodejs.org/en) v20.17.0+ (se recomiendan versiones LTS)
|
|
|
|
<div id="install-the-cli">
|
|
## Instalar la CLI
|
|
</div>
|
|
|
|
<CodeGroup>
|
|
```bash npm
|
|
npm i -g mint
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm add -g mint
|
|
```
|
|
</CodeGroup>
|
|
|
|
<div id="create-a-new-project">
|
|
## Crear un nuevo proyecto
|
|
</div>
|
|
|
|
Para crear un nuevo proyecto de documentación a partir de la plantilla inicial de Mintlify, ejecuta el siguiente comando:
|
|
|
|
```bash
|
|
mint new [directory]
|
|
```
|
|
|
|
Si no especificas un directorio, la CLI te solicitará crear un nuevo subdirectorio o sobrescribir el directorio actual.
|
|
|
|
<Warning>
|
|
Sobrescribir el directorio actual elimina todos los archivos existentes.
|
|
</Warning>
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--name` | Nombre del proyecto. La CLI lo solicita si no se proporciona. |
|
|
| `--theme` | [Tema](/es/customize/themes) del proyecto. La CLI lo solicita si no se proporciona. |
|
|
| `--force` | Sobrescribir 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`.
|
|
|
|
<div id="update">
|
|
## Actualizar
|
|
</div>
|
|
|
|
Si tu previsualización local no está sincronizada con la documentación desplegada, actualiza la CLI a la última versión:
|
|
|
|
```bash
|
|
mint update
|
|
```
|
|
|
|
Si `mint update` no está disponible en tu versión, reinstala la CLI con la última versión:
|
|
|
|
<CodeGroup>
|
|
```bash npm
|
|
npm i -g mint@latest
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm add -g mint@latest
|
|
```
|
|
</CodeGroup>
|
|
|
|
<div id="formatting">
|
|
## Formato
|
|
</div>
|
|
|
|
Para resaltado de sintaxis y formato de código en archivos MDX, recomendamos usar las siguientes extensiones:
|
|
|
|
- **Cursor, Windsurf, VS Code**: [Extensión MDX para VS Code](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) y [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
|
- **JetBrains**: [Plugin MDX para IntelliJ IDEA](https://plugins.jetbrains.com/plugin/14944-mdx) y [Prettier](https://prettier.io/docs/webstorm)
|
|
|
|
<div id="troubleshooting">
|
|
## Solución de problemas
|
|
</div>
|
|
|
|
<AccordionGroup>
|
|
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
|
|
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`
|
|
</Accordion>
|
|
<Accordion title="Problema: Se produce un error desconocido">
|
|
**Solución**: Ve a la raíz de tu dispositivo y elimina la carpeta `~/.mintlify`. Después, ejecuta `mint dev` nuevamente.
|
|
</Accordion>
|
|
<Accordion title="Error: permission denied">
|
|
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.
|
|
</Accordion>
|
|
<Accordion title="La previsualización local no se ve igual que la documentación en la web">
|
|
Es probable que esto se deba a una versión desactualizada de la CLI.
|
|
|
|
**Solución**: Ejecuta `mint update` para obtener los últimos cambios.
|
|
</Accordion>
|
|
<Accordion title="Paquete mintlify versus mint">
|
|
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`:
|
|
|
|
```bash
|
|
npm uninstall -g mintlify
|
|
npm cache clean --force
|
|
npm i -g mint
|
|
```
|
|
</Accordion>
|
|
<Accordion title="La versión del cliente muestra 'none' después de la instalación">
|
|
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.
|
|
</Accordion>
|
|
</AccordionGroup>
|