Skills

Mintlify: previsualizar documentación en local con el CLI mint

Para quienes quieren cambiar la documentación oficial o su sitio Mintlify y previsualizar primero en local. Instala mint en global y ejecuta mint dev en la raíz de documentación que contiene docs.json.

Official source · Mintlify docs

Install

npm i -g mint

Para quién

Si mantienes documentación Mintlify y quieres ver el efecto en esta máquina antes de empujar a producción, este repositorio oficial de docs encaja. Es Official Mintlify documentation. El repositorio es

https://github.com/mintlify/docs

El sitio de docs publicado es

https://mintlify.com/docs

El paquete CLI es

https://www.npmjs.com/package/mint

Encaja mejor quien ya tiene un directorio de docs con docs.json (este repositorio clonado o tu propio proyecto Mintlify), puede ejecutar npm en esta máquina y acepta solo este comando oficial de instalación: npm i -g mint. Es un CLI global, no un paquete de mercado de skills; no lo reescribas como skills add.

Si solo quieres leer en el navegador

https://mintlify.com/docs

y no planeas editar docs ni abrir una vista previa local, no necesitas el CLI. La primera vez, solo vista previa local. No ejecutes un comando de puesta en línea que no aparezca en esta página. Esta página no nombra ningún cliente de programación; mira la vista previa en el navegador.

Primer intento en 3 minutos

Usa solo esta ruta oficial de instalación:

npm i -g mint

Una instalación global cambia la línea de comandos de esta máquina. Confirma primero que aceptas un paquete global. No busques un plugin ni un mercado.

Requisitos previos: Node/npm está instalado; el directorio de trabajo actual es la raíz de docs, la capa donde se ve docs.json. Si aún no tienes ese archivo, clona primero el repositorio oficial de docs. No inventes un docs.json con un formato no documentado.

Luego ejecuta en esa raíz:

mint dev

Esto arranca una vista previa local y es un proceso local. Confirma que el puerto solo se accede en local y luego ejecuta. Abre en el navegador la dirección local que imprime y comprueba que una página de docs se renderiza.

Señal de éxito: el comando mint funciona y, tras mint dev, ves en el navegador un árbol de docs que corresponde a docs.json, no un error de docs.json ausente. Si dice que no estás en la raíz de docs, cd al directorio que contiene docs.json y vuelve a ejecutar; no añadas parámetros no documentados. Si mint no existe, vuelve a npm i -g mint; no cambies a un nombre de paquete no escrito.

Casos de uso

Caso 1: instalar Mint CLI. Oficialmente instala con npm i -g mint para previsualizar cambios de docs en local. Tras instalar, ejecuta mint en el terminal y confirma que el comando está en PATH. Es un efecto secundario global; no lo instales a ciegas en un entorno no fiable. Esta página no escribe un número de versión ni un sustituto npx mint; si faltan, usa solo esta instalación global.

Caso 2: previsualizar en la raíz de docs. Oficialmente ejecuta mint dev en la raíz de docs (donde está docs.json). Cambia el título o un párrafo de una página md existente, guarda y mira si la vista previa local se actualiza. No hagas un empuje de puesta en línea en el primer intento. Esta página no escribe detalles de recarga en caliente ni un puerto por defecto; toma la dirección de vista previa de la salida de la línea de comandos, no adivines.

Límites

Esto es el repositorio oficial de docs más la vista previa CLI, no un generador genérico de sitios estáticos. Sin docs.json, mint dev no tiene punto de partida oficial.

La instalación oficial es solo npm i -g mint. mint dev es vista previa, no un segundo instalador. No inventes una instalación de mercado de skills. El sitio publicado es una referencia de solo lectura, no una fuente de instalación.

El paquete global y arrancar dev tienen efectos secundarios. Confirma primero el directorio. Esta página no da pasos de despliegue, alojamiento o dominio personalizado; no hagas acciones de puesta en línea no escritas. Tampoco enumera otros subcomandos de mint; no adivines comandos que nunca aparecen.