Inicio rápido

Publica tu sitio de documentación y haz tu primer cambio.

Después de completar esta guía, tendrás un sitio de documentación en línea listo para personalizar y actualizar.

​

Antes de comenzar

Mintlify utiliza un enfoque de documentación como código para administrar tu documentación. Cada página de tu sitio tiene un archivo correspondiente almacenado en tu repositorio de documentación.

Cuando conectas tu repositorio de documentación a tu implementación de Mintlify, puedes trabajar en tu documentación localmente o en el editor web y sincronizar cualquier cambio con tu repositorio remoto.

​

Implementa tu sitio de documentación

Ve a mintlify.com/start y completa el proceso de configuración inicial. Durante la configuración, conectarás tu cuenta de GitHub, crearás o seleccionarás un repositorio para tu documentación e instalarás la Aplicación de GitHub para habilitar las implementaciones automáticas.

Después de la configuración inicial, tu sitio de documentación se implementa automáticamente y queda accesible en tu URL .mintlify.app.

Opcional: omitir la conexión con GitHub durante la configuración inicial

Si quieres comenzar rápidamente sin conectar tu propio repositorio, puedes omitir la conexión con GitHub durante la configuración inicial. Mintlify crea un repositorio privado en la organización mintlify-community y configura automáticamente la Aplicación de GitHub por ti.

Esto te permite usar el editor web de inmediato y migrar a tu propio repositorio más adelante.

​

Consulta tu sitio desplegado

Tu sitio de documentación ya se ha desplegado en https://<your-project-name>.mintlify.app.

Encuentra tu URL exacta en la página Overview de tu Dashboard de Mintlify.

Tu sitio ya está disponible para verse de inmediato. Usa esta URL para hacer pruebas y compartirla con tu equipo. Antes de compartirla con tus usuarios, quizá quieras añadir un dominio personalizado.

​

Haz tu primer cambio

CLI

1. Instala la CLI

   La CLI requiere Node.js v20.17.0 o superior. Usa una versión LTS para mayor estabilidad.

   npm

   npm i -g mint
   

   Consulta Instalar la CLI para ver todos los detalles y la resolución de problemas.

2. Clona tu repositorio

   Si aún no has clonado tu repositorio localmente, sigue las instrucciones en Clonar tu repositorio.

3. Edita una página

   Abre index.mdx en tu editor preferido y actualiza el campo description en el frontmatter:

   ---
   title: "Introduction"
   description: "Your custom description here"
   ---
   
4. Vista previa local

   Ejecuta el siguiente comando desde tu directorio de documentación:

   mint dev
   

   Ve la vista previa en http://localhost:3000.

5. Haz push de tus cambios

   Crea una confirmación (commit) y haz push de tus cambios para iniciar una implementación:

   git add .
   git commit -m "Update description"
   git push
   

   Mintlify implementa automáticamente tus cambios. Consulta el estado de implementación en la página de Overview de tu dashboard.

Editor web

1. Abre el editor web

   Navega al editor web en tu dashboard.

2. Edita una página

   Abre index.mdx y actualiza el campo description en el frontmatter:

   ---
   title: "Introduction"
   description: "Your custom description here"
   ---
   
3. Publicar

   Haz clic en el botón Publish en la esquina superior derecha de la barra de herramientas del editor web.

4. Ver en vivo

   En la página de Overview de tu dashboard, puedes ver el estado de implementación de tu sitio. Cuando la implementación haya finalizado, actualiza tu sitio de documentación para ver tus cambios en vivo.

​

Próximos pasos

Usar el editor web

Edita la documentación en tu navegador y obtén una vista previa de cómo se verán tus páginas al publicarlas.

Explorar comandos de la CLI

Encuentra enlaces rotos, verifica la accesibilidad, valida especificaciones de OpenAPI y más.

Agregar un dominio personalizado

Usa tu propio dominio para tu sitio de documentación.