> ## Documentation Index
> Fetch the complete documentation index at: https://omer-914cc1c6.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 completar 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 proceso de incorporación, tu sitio de documentación se publica automáticamente en una URL única con este formato:

```
https://<nombre-de-tu-proyecto>.mintlify.app
```

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

<Frame>
  <img src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/mintlify-domain-light.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=2996fe7332cfbab264eaf86de78224d3" 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/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/mintlify-domain-dark.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=8b40e210b3a239e2d7005b2ebd7d3afa" 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 realizar 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 la implementación cuando envías cambios a tu repositorio.

Instala la Aplicación de GitHub siguiendo las instrucciones de la lista de verificación de onboarding o desde tu dashboard.

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

<Frame>
  <img src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/github-app-installation-light.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=0a3f2a8882cb6716c622302ab5963a92" alt="Instalación de la GitHub App" className="block dark:hidden" width="3024" height="910" data-path="images/quickstart/github-app-installation-light.png" />

  <img src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/github-app-installation-dark.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=94c62cea749e8ed4f5fd56897956d81a" alt="Instalación de la GitHub App" 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 Dashboard de Mintlify.
2. Selecciona **My Profile** en la barra lateral.
3. Selecciona **Authorize GitHub account**. Esto abrirá una nueva pestaña con la página de autorización de GitHub.

<Info>
  Es posible que un administrador de tu organización en 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 herramientas existentes en su 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 su 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 con los repositorios de Git existentes. Este flujo es ideal para equipos técnicos que desean 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 theme={null}
  npm i -g mint
  ```

  ```bash pnpm theme={null}
  pnpm add -g mint
  ```
</CodeGroup>

<Info>
  Necesitas tener Node.js instalado en tu equipo. Si tienes problemas con 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 la configuración inicial.
2. Abre `index.mdx` y ve al inicio del archivo:

```mdx index.mdx theme={null}
---
title: "Introducción"
description: "Esta es la introducción a la documentación"
---
```

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

```mdx index.mdx {2} theme={null}
---
title: "Hola Mundo"
description: "Esta es la introducción a la documentación"
---
```

<div id="preview-the-changes">
  ### Visualiza una vista previa de los cambios
</div>

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

```bash theme={null}
mint dev
```

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

<Frame>
  <img src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/mintlify-dev-light.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=a24b188b587e0b27b68b86123411f07a" alt="Mintlify Dev" className="block dark:hidden" width="3024" height="1518" data-path="images/quickstart/mintlify-dev-light.png" />

  <img src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/mintlify-dev-dark.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=ba367443a9ede91d6b79fc83dcd00af3" 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, envíalos a tu repositorio.

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

Cuando la implementación se complete, tu actualización más reciente estará disponible en `<your-project-name>.mintlify.app`.

<Card title="Ir a agregar un domain personalizado" icon="arrow-down" href="#adding-a-custom-domain" horizontal>
  Opcionalmente, omite el flujo del editor web y ve directamente a agregar un domain 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 de trabajo es ideal para quienes prefieren trabajar en su navegador web sin herramientas de desarrollo locales adicionales.

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

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

<Info>
  Si no has instalado la Aplicación de GitHub, se te pedirá que la instales al abrir el editor web.
</Info>

<Frame>
  <img alt="El editor web de Mintlify en modo editor visual" src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/web-editor-light.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=1cf68220e551f01f2449490d20f5fe66" 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/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/web-editor-dark.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=b4fbc6d934f99186e54d005e921b9a2b" className="hidden dark:block" width="3011" height="1402" data-path="images/quickstart/web-editor-dark.png" />
</Frame>

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

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

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

Luego, en el editor, actualiza el campo title a "Hello World".

<Frame>
  <img alt="Edición en el editor web" src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/web-editor-editing-light.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=dba4ac2555d65a032db1b916e675024f" 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/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/web-editor-editing-dark.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=884188155cb4f084979fc0d15883dec8" className="hidden dark:block" width="3018" height="1127" data-path="images/quickstart/web-editor-editing-dark.png" />
</Frame>

<Tip>
  El editor incluye un completo conjunto 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 ediciones, selecciona el botón **Publish** en la esquina superior derecha. Tus cambios se despliegan de inmediato en tu sitio de documentación.

<Tip>
  Usa branches para previsualizar y revisar cambios mediante solicitudes de extracción antes de desplegar en tu sitio en producción.
</Tip>

Para más detalles sobre el uso del editor web, incluido el uso de branches y solicitudes de extracción para colaborar y previsualizar cambios, consulta nuestra [documentación del editor web](/es/editor/getting-started).

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

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

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

<Frame>
  <img src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/custom-domain-light.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=4bc19cade3f8be7eab420caa02b00e3d" alt="Dominio personalizado" className="block dark:hidden" width="3024" height="1142" data-path="images/quickstart/custom-domain-light.png" />

  <img src="https://mintcdn.com/omer-914cc1c6/zyJsbuZtXQKHf9Ui/images/quickstart/custom-domain-dark.png?fit=max&auto=format&n=zyJsbuZtXQKHf9Ui&q=85&s=9d0b45698899a93e85c9888571bd25b7" alt="Dominio personalizado" className="hidden dark:block" width="3018" height="1140" data-path="images/quickstart/custom-domain-dark.png" />
</Frame>

Ingresa tu dominio (por ejemplo, `docs.yourcompany.com`) y sigue las instrucciones proporcionadas para configurar los ajustes de DNS con tu proveedor de dominio.

<Table>
  | Record Type | Name                | Value              | TTL  |
  | ----------- | ------------------- | ------------------ | ---- |
  | CNAME       | docs (o subdominio) | cname.mintlify.app | 3600 |
</Table>

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

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

¡Enhorabuena! Has desplegado correctamente tu sitio de documentación con Mintlify. Aquí tienes algunos próximos pasos para mejorar tu documentación:

<Card title="Configura la configuración global" icon="settings" href="es/settings" horizontal>
  Configura el estilo a nivel de sitio, navigation, integrations y más con el archivo `docs.json`.
</Card>

<Card title="Personaliza tu tema" icon="paintbrush" href="es/themes" horizontal>
  Aprende a personalizar colores, tipografías 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 Accordion, pestañas y ejemplos de código.
</Card>

<Card title="Configura 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 inconvenientes durante la configuración, revisa estas soluciones comunes:

<AccordionGroup>
  <Accordion title="La vista previa local no funciona">
    Asegúrate de tener instalado Node.js v19+ 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">
    La implementación puede tardar algunos minutos. Revisa tus GitHub Actions (para un flujo de trabajo basado en código) o los registros de implementación en el Dashboard 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 de DNS estén configurados correctamente y espera el tiempo suficiente para la propagación de DNS (hasta 48 horas). Puedes usar herramientas como [DNSChecker](https://dnschecker.org) para verificar tu registro CNAME.
  </Accordion>
</AccordionGroup>
