Skip to main content

​
Configura tu entorno de desarrollo

Aprende a actualizar tu documentación localmente y a publicarla al público.

​
Edita y previsualiza

Durante el proceso de onboarding, 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.
Previsualizar te ayuda a asegurarte de que tus cambios se vean como esperas. Construimos una interfaz de línea de comandos para renderizar estos cambios localmente. 1. Instala la CLI de Mintlify para previsualizar 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á docs.json): mintlify dev

​
Publica tus cambios

Nuestra app de Github publica automáticamente tus cambios en tu sitio de documentación, así que no necesitas gestionar los despliegues por tu cuenta. 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.
Haz commit y push de tus cambios a Git para que tus cambios se actualicen 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 a través de nuestro panel.

​
Actualiza tu documentación

Agrega 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 estilo a tu documentación

Añade estilo a tu documentación con una marca personalizada.

Agrega endpoints de API

Implementa tu especificación OpenAPI y habilita la interacción de los usuarios con la API.

Integra analíticas

Obtén información a partir de las interacciones de los usuarios con tu documentación.

Aloja en un dominio personalizado

Mantén tu documentación en un subdominio de tu propio sitio web.