- La CLI de Mintlify instalada globalmente, o ejecuta los comandos con
npx mint.
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 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
indexoreadmeaparecen 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-startedse convierte en un grupo llamado Getting started. - La CLI omite los archivos y carpetas que empiezan por
.o_, las carpetasnode_modulesysnippets, y las rutas de tu archivo.mintignore.
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.
Debes autenticar la CLI con tu cuenta de Mintlify para habilitar la búsqueda y el asistente.
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:
--port:
localhost. Para abrir la previsualización en un teléfono u otro equipo de tu red, usa el flag --host:
--disable-openapi:
--disable-prefetch:
--groups:
<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.