> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-add-i-to-quickstart-8818.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Inicio rápido

> Publica tu documentación en minutos

Esta guía de inicio rápido te muestra cómo configurar y publicar tu sitio de documentación en minutos.

Al finalizar esta guía, tendrás un sitio de documentación en producción listo para personalizar y ampliar.

<Info>
  **Requisitos previos**: Antes de comenzar, [crea una cuenta](https://mintlify.com/start) y completa el onboarding.
</Info>

<div id="getting-started">
  ## Primeros pasos
</div>

Después de completar el onboarding, tu sitio de documentación se publica automáticamente en una URL única con este formato:

```
https://<your-project-name>.mintlify.app
```

Encuentra tu URL en la página de Overview de tu [dashboard](https://dashboard.mintlify.com/).

<Frame>
  <img src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/mintlify-domain-light.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=6a8ccbfd0a57c4fa4f752bf878fbd6fd" alt="Dominio de Mintlify" className="block dark:hidden" width="3024" height="1372" data-path="images/quickstart/mintlify-domain-light.png" />

  <img src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/mintlify-domain-dark.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=5618a452ec34a0fbca6a0cc65d8c358c" alt="Dominio de Mintlify" className="hidden dark:block" width="3008" height="1368" data-path="images/quickstart/mintlify-domain-dark.png" />
</Frame>

La URL de tu sitio está disponible de inmediato. Usa esta URL para hacer pruebas y compartirla con tu equipo mientras configuras tu sitio de documentación.

<div id="install-the-github-app">
  ### Instala la aplicación de GitHub
</div>

Mintlify ofrece una aplicación de GitHub que automatiza el despliegue cuando haces push de cambios a tu repositorio.

Instala la aplicación de GitHub siguiendo las instrucciones de la checklist de onboarding o desde tu panel.

1. Ve a **Settings** en tu panel de Mintlify.
2. Selecciona **GitHub App** en la barra lateral.
3. Selecciona **Install GitHub App**. Se abrirá una nueva pestaña con la página de instalación de la aplicación de GitHub.
4. Selecciona la organización o cuenta de usuario donde quieres instalar la aplicación.
5. Selecciona los repositorios que quieres conectar.

<Frame>
  <img src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/github-app-installation-light.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=36e7a85890f8881c6dbddc3fa69cd1d0" alt="Instalación de la aplicación de GitHub" className="block dark:hidden" width="3024" height="910" data-path="images/quickstart/github-app-installation-light.png" />

  <img src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/github-app-installation-dark.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=703b84af3df25b1fbd3274d72fac257d" alt="Instalación de la aplicación de GitHub" className="hidden dark:block" width="3016" height="906" data-path="images/quickstart/github-app-installation-dark.png" />
</Frame>

<Info>
  Actualiza los permisos de la aplicación de GitHub si mueves tu documentación a otro repositorio.
</Info>

<div id="authorize-your-github-account">
  ### Autoriza tu cuenta de GitHub
</div>

1. Ve a **Settings** en tu panel de Mintlify.
2. Selecciona **My Profile** en la barra lateral.
3. Selecciona **Authorize GitHub account**. Se abrirá una nueva pestaña con la página de autorización de GitHub.

<Info>
  Es posible que un administrador de tu organización de GitHub deba autorizar tu cuenta según la configuración de la organización.
</Info>

<div id="editing-workflows">
  ## Flujos de edición
</div>

Mintlify ofrece dos flujos para crear y mantener tu documentación:

<Card title="Flujo basado en código" icon="terminal" horizontal href="#code-based-workflow">
  Para quienes prefieren trabajar con sus herramientas existentes en el entorno local. Haz clic para ir a esta sección.
</Card>

<Card title="Flujo del editor web" icon="mouse-pointer-2" horizontal href="#web-editor-workflow">
  Para quienes prefieren una interfaz visual en el navegador. Haz clic para ir a esta sección.
</Card>

<div id="code-based-workflow">
  ## Flujo de trabajo basado en código
</div>

El flujo de trabajo basado en código se integra con tu entorno de desarrollo y los repositorios de Git existentes. Este flujo es ideal para equipos técnicos que quieren gestionar la documentación junto con el código.

<div id="install-the-cli">
  ### Instalar la CLI
</div>

Para trabajar localmente con tu documentación, instala la Interfaz de Línea de Comandos (CLI), llamada [mint](https://www.npmjs.com/package/mint), ejecutando este comando en tu terminal:

<CodeGroup>
  ```bash npm
  npm i -g mint
  ```

  ```bash pnpm
  pnpm add -g mint
  ```
</CodeGroup>

<Info>
  Necesitas tener Node.js instalado en tu equipo. Si tienes problemas durante la instalación, consulta la guía de solución de problemas.
</Info>

<div id="edit-the-documentation">
  ### Edita la documentación
</div>

Después de configurar tu entorno, puedes empezar a editar tus archivos de documentación. Por ejemplo, actualiza el título de la página de introducción:

1. Abre el repositorio que creaste durante el onboarding.
2. Abre `index.mdx` y ve a la parte superior del archivo:

```mdx index.mdx
---
title: "Introducción"
description: "Introducción a la documentación"
---
```

3. Actualiza el campo `title` a `"Hello World"`.

```mdx index.mdx {2}
---
title: "Hola, mundo"
description: "Introducción a la documentación"
---
```

<div id="preview-the-changes">
  ### Previsualiza los cambios
</div>

Para ver una vista previa de los cambios en local, ejecuta el siguiente comando:

```bash
mint dev
```

Tu vista previa estará disponible en `localhost:3000`.

<Frame>
  <img src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/mintlify-dev-light.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=514533070d074e0c78031dcc93b42fba" alt="Mintlify Dev" className="block dark:hidden" width="3024" height="1518" data-path="images/quickstart/mintlify-dev-light.png" />

  <img src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/mintlify-dev-dark.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=24b36f79a15531762dc2a76f76e08e7e" alt="Mintlify Dev" className="hidden dark:block" width="3018" height="1518" data-path="images/quickstart/mintlify-dev-dark.png" />
</Frame>

<div id="push-the-changes">
  ### Envía los cambios
</div>

Cuando estés listo para publicar tus cambios, súbelos a tu repositorio.

Mintlify detecta automáticamente los cambios, compila tu documentación y despliega las actualizaciones en tu sitio. Supervisa el estado del despliegue en el historial de commits de tu repositorio de GitHub o en el [panel](https://dashboard.mintlify.com).

Cuando termine el despliegue, tu actualización más reciente estará disponible en `<your-project-name>.mintlify.app`.

<Card title="Ir a agregar un dominio personalizado" icon="arrow-down" href="#adding-a-custom-domain" horizontal>
  Opcionalmente, omite el flujo del editor web y ve directamente a agregar un dominio personalizado.
</Card>

<div id="web-editor-workflow">
  ## Flujo de trabajo del editor web
</div>

El flujo de trabajo del Editor web ofrece una interfaz WYSIWYG (what you see is what you get) para crear y editar documentación. Este flujo es ideal para quienes prefieren trabajar en el navegador sin herramientas de desarrollo locales adicionales.

<div id="access-the-web-editor">
  ### Accede al editor web
</div>

1. Inicia sesión en tu [panel](https://dashboard.mintlify.com).
2. Selecciona **Editor** en la barra lateral izquierda.

<Info>
  Si no has instalado la app de GitHub, se te pedirá instalarla cuando abras el editor web.
</Info>

<Frame>
  <img alt="El editor web de Mintlify en modo editor visual" src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/web-editor-light.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=ddc4173aca7d120ff61309a20e33efb5" className="block dark:hidden" width="3024" height="1404" data-path="images/quickstart/web-editor-light.png" />

  <img alt="El editor web de Mintlify en modo editor visual" src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/web-editor-dark.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=e29112852b79600f5b2538e4acc7c161" className="hidden dark:block" width="3011" height="1402" data-path="images/quickstart/web-editor-dark.png" />
</Frame>

<div id="edit-the-documentation">
  ### Editar la documentación
</div>

En el Editor web, puedes navegar por los archivos de tu documentación desde la barra lateral. Actualicemos la página de introducción:

Busca y selecciona `index.mdx` en el explorador de archivos.

Luego, en el editor, actualiza el campo de título a "Hello World".

<Frame>
  <img alt="Edición en el Editor web" src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/web-editor-editing-light.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=82ce196dbb6e56a73c1bf4d270de0b9c" className="block dark:hidden" width="3022" height="1130" data-path="images/quickstart/web-editor-editing-light.png" />

  <img alt="Edición en el Editor web" src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/web-editor-editing-dark.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=0290fee1d89ceabc505f95e2b22dfd8d" className="hidden dark:block" width="3018" height="1127" data-path="images/quickstart/web-editor-editing-dark.png" />
</Frame>

<Tip>
  El editor ofrece un conjunto completo de herramientas de formato y componentes. Escribe <kbd>/</kbd> en el editor para abrir el menú de comandos y acceder a estas herramientas.
</Tip>

<div id="publish-your-changes">
  ### Publica tus cambios
</div>

Cuando estés conforme con tus cambios, selecciona el botón **Publish** en la esquina superior derecha. Tus cambios se publicarán de inmediato en tu sitio de documentación.

<Tip>
  Usa ramas para previsualizar y revisar cambios mediante pull requests antes de publicar en tu sitio en producción.
</Tip>

Para obtener más detalles sobre el uso del editor web, incluido cómo usar ramas y pull requests para colaborar y previsualizar cambios, consulta nuestra [documentación del editor web](/es/editor/getting-started).

<div id="adding-a-custom-domain">
  ## Añadir un dominio personalizado
</div>

Si bien tu subdominio `<your-project-name>.mintlify.app` funciona bien para pruebas y desarrollo, la mayoría de los equipos prefieren usar un dominio personalizado para la documentación en producción.

Para añadir un dominio personalizado, ve a la página [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) en tu panel.

<Frame>
  <img src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/custom-domain-light.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=9c1f4ff3d2a4440ecdcaaba887f87ceb" alt="Custom Domain" className="block dark:hidden" width="3024" height="1142" data-path="images/quickstart/custom-domain-light.png" />

  <img src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/foJqm5unL7FbRYPD/images/quickstart/custom-domain-dark.png?fit=max&auto=format&n=foJqm5unL7FbRYPD&q=85&s=92fac775a1e7d0d95cb725e85279e83e" alt="Custom Domain" className="hidden dark:block" width="3018" height="1140" data-path="images/quickstart/custom-domain-dark.png" />
</Frame>

Introduce tu dominio (por ejemplo, `docs.yourcompany.com`) y sigue las instrucciones para configurar la DNS con tu proveedor de dominios.

<Table>
  | Tipo de registro | Nombre              | Valor              | TTL  |
  | ---------------- | ------------------- | ------------------ | ---- |
  | CNAME            | docs (o subdominio) | cname.mintlify.app | 3600 |
</Table>

<Info>
  Los cambios en la DNS pueden tardar hasta 48 horas en propagarse, aunque a menudo se completan mucho antes.
</Info>

<div id="next-steps">
  ## Próximos pasos
</div>

¡Felicidades! Has desplegado correctamente tu sitio de documentación con Mintlify. Aquí tienes pasos recomendados para mejorar tu documentación:

<Card title="Configura los ajustes globales" icon="settings" href="es/settings" horizontal>
  Configura el estilo del sitio, la navegación, las integraciones y más con el archivo `docs.json`.
</Card>

<Card title="Personaliza tu tema" icon="paintbrush" href="es/themes" horizontal>
  Aprende a personalizar colores, fuentes y la apariencia general de tu sitio de documentación.
</Card>

<Card title="Organiza la navegación" icon="map" href="es/navigation" horizontal>
  Estructura tu documentación con una navegación intuitiva para ayudar a los usuarios a encontrar lo que necesitan.
</Card>

<Card title="Añade componentes interactivos" icon="puzzle" href="/es/components/accordions" horizontal>
  Mejora tu documentación con componentes interactivos como acordeones, pestañas y ejemplos de código.
</Card>

<Card title="Configura las referencias de API" icon="code" href="/es/api-playground/overview" horizontal>
  Crea referencias de API interactivas con especificaciones OpenAPI y AsyncAPI.
</Card>

<div id="troubleshooting">
  ## Solución de problemas
</div>

Si tienes problemas durante la configuración, revisa estas soluciones comunes:

<AccordionGroup>
  <Accordion title="La vista previa local no funciona">
    Asegúrate de tener Node.js v19+ instalado y de ejecutar el comando `mint dev` desde el directorio que contiene tu archivo `docs.json`.
  </Accordion>

  <Accordion title="Los cambios no se reflejan en el sitio en producción">
    El despliegue puede tardar varios minutos. Revisa tus GitHub Actions (para flujos de trabajo basados en código) o los registros de despliegue en el panel de Mintlify para asegurarte de que no haya errores de compilación.
  </Accordion>

  <Accordion title="El dominio personalizado no se conecta">
    Verifica que tus registros DNS estén configurados correctamente y espera el tiempo necesario para la propagación de DNS (hasta 48 horas). Puedes usar herramientas como [DNSChecker](https://dnschecker.org) para verificar tu registro CNAME.
  </Accordion>
</AccordionGroup>
