Inicio Rápido

Comienza a construir documentación impresionante en menos de 5 minutos

Configura tu desarrollo

Aprende cómo actualizar tus documentos localmente y desplegarlos al público.

Editar y previsualizar

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 nuestrodashboard. Para clonar el repositorio localmente, sigue estasinstrucciones en tu terminal.

Vista previa de cambios

La vista previa 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 elMintlify CLI 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

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

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óndocs.json. Siéntete libre de eliminar el archivomint.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 tú mismo. Puedes encontrar el enlace para instalar en tudashboard. 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

Haz commit 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 tus cambios con éxito, también puedes actualizar manualmente tu documentación a través de nuestrodashboard.

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 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.