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. Puedes usar tu propio repositorio Git o un repositorio alojado en Mintlify.

Elige cómo quieres gestionar el repositorio.

Alojado en Mintlify

Mintlify crea un repositorio privado de GitHub conectado a tu implementación de Mintlify.

Elige esta opción si:

• Solo trabajarás en el editor web y no quieres usar Git localmente.
• Quieres comenzar rápidamente sin conectar un repositorio.
• Quieres que Mintlify administre tu repositorio de documentación por ti.

Tu propio repositorio

Conecta tu propio repositorio Git a tu implementación de Mintlify.

Elige esta opción si:

• Trabajarás localmente y quieres sincronizar con tu repositorio remoto.
• Ya tienes un repositorio para tu documentación.
• Quieres que tu documentación esté bajo tu propia organización de GitHub.

¿No estás seguro de cuál elegir? Comienza con Alojado en Mintlify. Puedes migrar a tu propio repositorio en cualquier momento si se adapta mejor a tus necesidades.

​

Implementa tu sitio de documentación

Alojado en Mintlify

1. Crea tu cuenta

   Ve a mintlify.com/start y crea tu cuenta.

2. Omite la conexión con GitHub

   Cuando se te pida conectar GitHub, haz clic en Skip para usar un repositorio alojado en Mintlify.

3. Completa la configuración inicial

   Sigue las indicaciones de configuración inicial para preparar tu documentación. Mintlify crea automáticamente un repositorio privado en la organización mintlify-community y configura la Aplicación de GitHub por ti.

4. Tu sitio está implementado

   Tu documentación se implementa de inmediato y está accesible en tu URL .mintlify.app.

Tu propio repositorio

1. Crea tu cuenta

   Ve a mintlify.com/start y crea tu cuenta.

2. Conecta GitHub

   Cuando se te pida, inicia sesión en tu cuenta de GitHub y autentícate.

3. Completa la configuración inicial

   Sigue las indicaciones restantes de configuración inicial para crear un repositorio y continuar a tu dashboard.

4. Instala la Aplicación de GitHub

   Instala la Aplicación de GitHub de Mintlify para habilitar implementaciones automáticas. Esto permite que Mintlify se sincronice con tu repositorio e implemente los cambios automáticamente cuando hagas push.

5. Opcional: selecciona un repositorio

   Si quieres usar un repositorio diferente del que se creó durante la configuración inicial para tu documentación, selecciónalo en la página de Git settings de tu dashboard. Tu repositorio de documentación debe tener un archivo docs.json válido para poder implementar.

6. Tu sitio está implementado

   Tu documentación se implementa y está accesible en tu URL .mintlify.app. Los cambios futuros que hagas push a tu repositorio desencadenarán automáticamente nuevas implementaciones.

Para obtener más información sobre la Aplicación de GitHub y sus permisos, consulta GitHub.

​

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

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

Obtén más información sobre el editor web

Explora las funciones y los flujos de trabajo de edición.

Configura un entorno de desarrollo local

Usa la CLI para obtener una vista previa de tu documentación en local mientras escribes y editas.

Agrega un dominio personalizado

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