Desplegar un sitio
mint deploy desde el directorio de documentación. El directorio debe contener un archivo docs.json.
https://<subdomain>.mintlify.site e imprime la URL de un repositorio Git alojado y un token de escritura de corta duración. No sube archivos. A continuación, el agente:
- Clona el repositorio alojado en un directorio independiente, pasando el token de escritura como encabezado
Authorization: Bearersolo para ese proceso de Git. - Copia
docs.json, las páginas y los recursos en la raíz del repositorio. - Hace commit y push a
main. El push inicia una compilación.
mint deploy desde el mismo directorio para obtener un nuevo token de escritura, o pasa --new --subdomain <name> para crear otro sitio.
Desplegar en cada push desde GitHub
mint deploy --github configura un flujo de trabajo que despliega el sitio en cada push a la rama predeterminada del repositorio. El flujo de trabajo se autentica con el token de identidad OIDC de GitHub, por lo que el repositorio no almacena ningún secreto.
--github requiere un remoto origin de GitHub y la CLI de GitHub con una sesión iniciada que tenga acceso al repositorio.
- Aprovisiona el sitio o reutiliza el sitio de un
mint deployanterior en el mismo directorio. - Confía en el repositorio y en su rama predeterminada para desplegar el sitio.
- Escribe
.github/workflows/mintlify.ymlen la raíz del repositorio.
mint deploy en GitHub Actions, que hace push del commit extraído al sitio.
Si tu documentación está en un subdirectorio, ejecuta el comando desde la raíz del repositorio y pasa el subdirectorio con --directory. El subdirectorio se convierte en la raíz del sitio, y el flujo de trabajo solo se ejecuta cuando cambian archivos de ese subdirectorio o el propio flujo de trabajo.
.github/workflows/mintlify.yml ya existe con un contenido diferente, el comando se detiene. Pasa --force para sobrescribirlo.
--github solo funciona con sitios no reclamados. Para desplegar un sitio reclamado desde GitHub, conecta el repositorio desde el panel de control.Reclamar el sitio
mint deploy caduca a menos que una persona lo reclame. Cuando reclamas un sitio, te conviertes en administrador de la organización del sitio, por lo que puedes gestionarlo desde el panel de control.
-
El agente pregunta qué dirección de correo electrónico debe ser propietaria del sitio y luego ejecuta:
Para obtener el enlace en el mismo paso, ejecuta
mint deploy --email <email>en su lugar. - Abre el enlace de reclamación.
- Inicia sesión en Mintlify o crea una cuenta.
- Copia el código que se muestra y pégaselo al agente.
-
El agente completa la reclamación con ese código:
mint claim desde el mismo directorio que mint deploy, o pasa --directory. La CLI almacena las credenciales del agente y las lee durante la reclamación, por lo que los agentes no deben leerlas ni imprimirlas.
Después de reclamar un sitio, la página de reclamación enlaza al panel de control y al sitio en vivo.
Usar auth.md sin la CLI
https://mintlify.com/auth.md. Describe el mismo flujo como solicitudes HTTP sin procesar: registrar una identidad de agente anónima, aprovisionar un sitio y entregar la cuenta a una persona mediante la página de reclamación.