Saltar al contenido principal

Requisitos previos

  • La CLI de Mintlify instalada globalmente, o ejecuta los comandos con npx mint.

Iniciar la previsualización local

Navega al directorio de tu documentación y ejecuta:
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:
Para generar una previsualización sin instalar la CLI globalmente, ejecuta:

Previsualizar un directorio sin un archivo docs.json

Si ejecutas mint dev en un directorio que no tiene un archivo docs.json, la CLI genera un archivo docs.json a partir de la estructura de tu directorio. La navegación generada sigue estos patrones:
  • Crea un grupo llamado Introduction para los archivos Markdown y MDX en la raíz del directorio.
  • Crea un grupo para cada subdirectorio de nivel superior, y los subdirectorios anidados se convierten en subgrupos.
  • Las páginas llamadas index o readme aparecen primero en su grupo. Las demás páginas y carpetas se ordenan alfabéticamente, o numéricamente si los títulos contienen números.
  • Los nombres de los grupos usan los nombres de los subdirectorios, sin ningún prefijo numérico inicial. Por ejemplo, una carpeta llamada 01-getting-started se convierte en un grupo llamado Getting started.
  • La CLI omite los archivos y carpetas que empiezan por . o _, las carpetas node_modules y snippets, y las rutas de tu archivo .mintignore.
El nombre del sitio proviene del campo name de un archivo package.json en el directorio o en su directorio padre. Si no hay un archivo package.json, la CLI usa el nombre del directorio. Edita el archivo docs.json generado para personalizar tu navegación, tema y colores.
Si escribes en VS Code o Cursor, la extensión Mintlify MDX ejecuta esta previsualización en un panel junto a tu editor y la desplaza para coincidir con la página que estás editando.

Iniciar sesión para búsqueda y asistente

Debes autenticar la CLI con tu cuenta de Mintlify para habilitar la búsqueda y el asistente.
Después de autenticarte con el comando mint login, la CLI almacena tus credenciales en el almacén de credenciales de tu sistema operativo para que permanezcas conectado entre sesiones. La CLI también te solicita que selecciones un proyecto predeterminado. 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:
Para cerrar sesión, ejecuta:

Puertos personalizados

Por defecto, la CLI usa el puerto 3000. Para usar un puerto diferente, usa el flag --port:
Si el puerto ya está en uso, la CLI intenta automáticamente el siguiente puerto disponible.

Previsualizar en otros dispositivos

Por defecto, la previsualización local solo acepta conexiones desde tu propio equipo en localhost. Para abrir la previsualización en un teléfono u otro equipo de tu red, usa el flag --host:
A continuación, la CLI muestra una URL de red que otros dispositivos de la misma red pueden abrir.

Omitir el procesamiento de OpenAPI

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

Deshabilitar la precarga de navegación

De forma predeterminada, la previsualización 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 previsualización local, deshabilita la precarga con el flag --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.

Previsualizar como un grupo específico

Si usas control de acceso basado en grupos, previsualiza como un grupo de autenticación específico con el flag --groups:
Por defecto, la previsualización local muestra el contenido como un lector sin sesión iniciada. Para comprobar el contenido de <Visibility for="signed-in">, usa el flag --signed-in para previsualizar como un lector con sesión iniciada sin grupos. El flag --groups también previsualiza como un lector con sesión iniciada.
Consulta Configuración de autenticación para más información sobre grupos.