Configura tu desarrollo
Aprende cómo actualizar tus documentos localmente y desplegarlos al público.callout
Editar y previsualizar
Clona tus documentos localmente
Clona tus documentos localmente
Durante el proceso de incorporación, creamos un repositorio en tu Github con
el contenido de tus documentos. Puedes encontrar este repositorio en nuestro
dashboard. Para clonar el repositorio
localmente, sigue estas
instrucciones
en tu terminal.
Previsualizar cambios
Previsualizar cambios
La previsualización te ayuda a asegurarte de que tus cambios se vean como se pretende. Hemos construido una
interfaz de línea de comandos para renderizar estos cambios localmente. 1. Instala la
Mintlify CLI para previsualizar los
cambios en 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
mint.json está):
mintlify devDespliega tus cambios
Instala nuestra aplicación de Github
Instala nuestra aplicación de Github
Nuestra aplicación de Github despliega automáticamente tus cambios en el sitio de tu documentación, así
no necesitas gestionar los despliegues tú mismo. Puedes encontrar el enlace para instalar en
tu
dashboard. Una vez que el bot ha sido
instalado con éxito, debería haber una marca de verificación junto al hash del commit
del repositorio.
Sube tus cambios
Sube tus cambios
Haz commit y sube tus cambios a
Git
para que tus cambios se actualicen en el sitio de tu documentación. Si subes y no ves que
la aplicación de Github haya desplegado tus cambios con éxito, también puedes
actualizar manualmente tus documentos a través de nuestro
dashboard.
Actualiza el cambio de tus documentos
Agrega contenido directamente en tus archivos con sintaxis MDX y componentes de React. Puedes usar cualquiera de nuestros componentes, o incluso construir los tuyos propios.Estiliza tus documentos
Añade estilo a tus documentos con una marca personalizada.
Añade endpoints de API
Implementa tu especificación OpenAPI y habilita la interacción del usuario con la API.
Integra análisis
Obtén información de las interacciones de los usuarios con tu documentación.
Aloja en un dominio personalizado
Mantén tus documentos en el subdominio de tu propio sitio web.
