Previsualización local

• La CLI de Mintlify instalada globalmente, o ejecuta los comandos con npx mint.
• Un directorio de documentación con un archivo docs.json válido.

Navega al directorio de tu documentación que contiene el archivo docs.json y ejecuta:

mint dev

La previsualización local se inicia en http://localhost:3000. A medida que editas, los cambios aparecen en tiempo real.

Por defecto, la previsualización se abre automáticamente en tu navegador. Para evitar que el navegador se abra, usa el flag --no-open:

mint dev --no-open

Para generar una previsualización sin instalar la CLI globalmente, ejecuta:

npx mint dev

Debes autenticar la CLI con tu cuenta de Mintlify para habilitar la búsqueda y el asistente.

mint login

Después de autenticarte con el comando mint login, la CLI almacena tus credenciales en ~/.config/mintlify/config.json para que permanezcas conectado entre sesiones. La CLI también te solicita que selecciones un proyecto predeterminado, que comandos como mint automations utilizan.

Una vez que hayas iniciado sesión, ejecuta mint dev para iniciar la previsualización local con la búsqueda y el asistente habilitados. El asistente usa el mismo contenido indexado que tu sitio de documentación desplegado.

Para verificar el estado de tu autenticación, ejecuta:

mint status

Para cerrar sesión, ejecuta:

mint logout

Por defecto, la CLI usa el puerto 3000. Para usar un puerto diferente, usa el flag --port:

mint dev --port 3333

Si el puerto ya está en uso, la CLI intenta automáticamente el siguiente puerto disponible.

Si tienes muchos archivos OpenAPI, omite el procesamiento de OpenAPI durante el desarrollo local para mejorar el rendimiento con el flag --disable-openapi:

mint dev --disable-openapi

De forma predeterminada, la vista previa local precarga las páginas cercanas para que la navegación entre ellas se sienta instantánea. En sitios muy grandes, esto puede ralentizar la página que estás viendo, porque muchas páginas se compilan en segundo plano al mismo tiempo.

Si tienes miles de páginas y notas cargas de página lentas durante la vista previa local, deshabilita la precarga con el flag --disable-prefetch:

mint dev --disable-prefetch

Con la precarga deshabilitada, las páginas se compilan solo cuando navegas a ellas. Las cargas de página individuales tardan más que una página precargada, pero la página que solicitas no compite con la compilación en segundo plano.

Si usas control de acceso basado en grupos, previsualiza como un grupo de autenticación específico con el flag --groups:

mint dev --groups admin

Consulta Configuración de autenticación para más información sobre grupos.