Configura tu entorno de desarrollo#
Aprende a actualizar tu documentación localmente y a publicarla.
Edita y vista previa#
Clona tu documentación localmente
Durante el proceso de incorporación, creamos un repositorio en tu GitHub con el contenido de tu documentación. Puedes encontrar este repositorio en nuestro panel. Para clonar el repositorio localmente, sigue estas instrucciones en tu terminal.
Vista previa de los cambios
La vista previa te ayuda a asegurarte de que tus cambios se vean como esperas. Creamos una
interfaz de línea de comandos para renderizar estos cambios localmente. 1. Instala la
Mintlify CLI para obtener una vista previa de los
cambios de la documentación localmente con este comando: npm i -g mintlify
2. Ejecuta el siguiente comando en la raíz de tu documentación (donde está
mint.json): mintlify dev
Despliega tus cambios#
Instala nuestra app de GitHub
Nuestra app de GitHub despliega automáticamente tus cambios en tu sitio de documentación, por lo que no necesitas gestionar los despliegues tú mismo. Puedes encontrar el enlace para instalarla en tu panel. Una vez que el bot se haya instalado correctamente, debería aparecer una marca de verificación junto al hash del commit del repositorio.
Sube (push) tus cambios
Haz commit y realiza push de tus cambios a Git para que se reflejen en tu sitio de documentación. Si haces push y no ves que la app de GitHub haya desplegado correctamente tus cambios, también puedes actualizar manualmente tu documentación desde nuestro panel.
Actualiza tu documentación#
Añade contenido directamente en tus archivos con sintaxis MDX y componentes de React. Puedes usar cualquiera de nuestros componentes o incluso crear los tuyos propios.
Dale personalidad a tu documentación con branding personalizado.
Implementa tu especificación OpenAPI y habilita la interacción de los usuarios con la API.
Obtén insights a partir de las interacciones de los usuarios con tu documentación.
Mantén tu documentación en el subdominio de tu propio sitio web.