Capacidades

Comienza a construir documentación increíble en menos de 5 minutos

Configura tu desarrollo

Aprende cómo actualizar tu documentación localmente y desplegarla al público.

Editar y previsualizar

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 de control. Para clonar el repositorio localmente, sigue estas instrucciones en tu terminal.

Previsualizar cambios

La previsualización te ayuda a asegurarte de que tus cambios se vean como lo deseas. Construimos una interfaz de línea de comandos para renderizar estos cambios localmente.

1. Instala el CLI de Mintlify 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 está docs.json): mintlify dev

Si actualmente estás usando el archivo de configuración heredado mint.json, por favor actualiza el CLI de Mintlify:

npm i -g mintlify@latest Y ejecuta el nuevo comando de actualización en tu repositorio de documentación:

mintlify upgrade Ahora deberías estar usando el nuevo archivo de configuración docs.json. Puedes eliminar el archivo mint.json de tu repositorio.

Despliega tus cambios

Instala nuestra aplicación de Github

Nuestra aplicación de Github despliega automáticamente tus cambios en tu sitio de documentación, así que no necesitas gestionar los despliegues por ti mismo. Puedes encontrar el enlace para instalar en tu panel de control. Una vez que el bot ha sido instalado exitosamente, debería haber una marca de verificación junto al hash del commit del repositorio.

Sube tus cambios

Confirma y sube tus cambios a Git para que tus cambios se actualicen en tu sitio de documentación. Si subes y no ves que la aplicación de Github haya desplegado exitosamente tus cambios, también puedes actualizar tu documentación manualmente a través de nuestro panel de control.

Actualiza tu documentación

Agrega contenido directamente en tus archivos con sintaxis MDX y componentes React. Puedes usar cualquiera de nuestros componentes, o incluso construir los tuyos propios.

Agregar Contenido Con MDX

Agrega contenido a tu documentación con sintaxis MDX.

Agregar Bloques de Código

Agrega código directamente a tu documentación con resaltado de sintaxis.

Agregar Imágenes

Agrega imágenes a tu documentación para hacerla más atractiva.

Agregar Componentes Personalizados

Agrega plantillas a tu documentación para hacerla más reutilizable.