mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
677ae9374e
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
216 lines
12 KiB
Plaintext
216 lines
12 KiB
Plaintext
---
|
|
title: "Inicio rápido"
|
|
description: "Comienza con Mintlify desplegando tu sitio de documentación en minutos y realizando tu primer cambio de contenido con el editor web o Git."
|
|
keywords: ["quickstart","deploy","get started","first steps","tutorial","setup","onboarding"]
|
|
boost: 3
|
|
---
|
|
|
|
import SetupAgentPrompt from "/snippets/es/setup-agent-prompt.mdx";
|
|
|
|
Después de completar esta guía, tendrás un sitio de documentación en línea listo para personalizar y actualizar.
|
|
|
|
<Visibility for="humans">
|
|
<Tip>
|
|
¿Utilizas un agente de IA?
|
|
|
|
Copia el siguiente prompt para que tu agente configure el sitio por ti. Le indica a tu agente que cree tu cuenta y despliegue tu sitio. También añade la [skill](/es/ai/skillmd) y el [servidor MCP](/es/ai/model-context-protocol) de Mintlify para obtener mejores resultados cuando actualices tu contenido.
|
|
|
|
El prompt divide el inicio rápido en tareas que tu agente puede completar y le indica que te pida cualquier información que necesite mientras lo configura todo.
|
|
</Tip>
|
|
|
|
<SetupAgentPrompt />
|
|
</Visibility>
|
|
|
|
<Visibility for="agents">
|
|
<div id="set-up-mintlify-for-the-user">
|
|
## Configura Mintlify para el usuario
|
|
</div>
|
|
|
|
Si el usuario te pidió configurar Mintlify, un sitio de documentación o un proyecto local, completa el siguiente flujo de trabajo. Pide al usuario únicamente la información o las aprobaciones que no puedas proporcionar. No dirijas al usuario al inicio rápido basado en el navegador, a menos que no puedas ejecutar comandos de terminal.
|
|
|
|
1. Ejecuta `node --version` y confirma que indica Node.js v20.17.0 o posterior; se prefiere una versión LTS.
|
|
2. Ejecuta `mint --version`. Si el comando no está disponible, instala la CLI con `npm i -g mint` o `pnpm add -g mint`. Si el comando funciona, ejecuta `mint update`.
|
|
3. Ejecuta `mint status` antes de iniciar la autenticación. Si ya muestra una organización, conserva la sesión existente y no crees otra cuenta.
|
|
4. Si el usuario tiene una cuenta, ejecuta `mint login`. Si no la tiene, pide su nombre, apellido, empresa y correo electrónico. Después, ejecuta:
|
|
|
|
```bash
|
|
mint signup \
|
|
--firstName <first-name> \
|
|
--lastName <last-name> \
|
|
--company <company> \
|
|
--email <email>
|
|
```
|
|
|
|
`mint signup` espera la verificación por correo electrónico, así que mantenlo ejecutándose como proceso en segundo plano cuando tu entorno admita comandos en segundo plano. Indica al usuario que haga clic en el enlace de verificación y apruebe la CLI en el navegador. Nunca inventes datos de registro.
|
|
5. Después de que el usuario complete la verificación y la configuración inicial, ejecuta `mint status` de nuevo. Confirma que indique su correo electrónico, organización y subdominio. Si la organización existe pero no aparece ningún subdominio, pídele al usuario que termine de seleccionar o conectar un repositorio de GitHub en la pestaña del navegador de configuración inicial. Después, vuelve a intentarlo.
|
|
6. Si el usuario tiene un repositorio de documentación existente, clónalo o ábrelo y conserva su contenido. Para un proyecto local nuevo, crea la estructura en un directorio nuevo y vacío con `mint new <directory> --name <name> --theme <theme>` o `mint new <directory> --template <template-name>`. Pregunta qué tema o plantilla prefiere si no lo ha especificado. No uses `--force` en un directorio que contenga archivos del usuario.
|
|
7. Ejecuta `mint dev --no-open` desde el directorio que contiene `docs.json` como un proceso en segundo plano. Confirma que la URL local se cargue, comunícasela al usuario y detén el proceso cuando ya no sea necesario.
|
|
8. Ejecuta `mint validate` y `mint broken-links`. Corrige los problemas causados por tus cambios antes de continuar.
|
|
9. Si un repositorio de Git respalda el proyecto y el usuario pidió desplegarlo, confirma y haz push de los cambios. Un push a la rama de producción activa un despliegue. No sobrescribas un repositorio existente con contenido inicial.
|
|
10. Ejecuta `mint status` para obtener el subdominio configurado y verifica que `https://<subdomain>.mintlify.site` se cargue antes de informar que el despliegue se completó.
|
|
|
|
El usuario solo debe completar acciones en el navegador para la verificación del correo electrónico, la aprobación de OAuth y la conexión o autorización de GitHub. Tú debes mantener el control del flujo de terminal y reanudarlo después de cada acción del usuario. Para consultar flags y resolver problemas, usa la [referencia de comandos de la CLI](/es/cli/commands).
|
|
</Visibility>
|
|
|
|
<div id="before-you-begin">
|
|
## Antes de comenzar
|
|
</div>
|
|
|
|
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 <Tooltip tip="El código fuente de tu documentación donde se almacenan todos los archivos y su historial. El editor web se conecta a tu repositorio de documentación para acceder y modificar el contenido, o puedes editar los archivos localmente en tu IDE preferido.">repositorio</Tooltip> de documentación.
|
|
|
|
Cuando conectas tu repositorio de documentación a tu proyecto, puedes trabajar en tu documentación localmente o en el editor web y sincronizar cualquier cambio con tu repositorio remoto.
|
|
|
|
<div id="deploy-your-documentation-site">
|
|
## Implementa tu sitio de documentación
|
|
</div>
|
|
|
|
<Visibility for="humans">
|
|
Ve a [mintlify.com/start](https://mintlify.com/start) y completa el proceso de configuración inicial. Durante la configuración, asignas un nombre a tu sitio y respondes algunas preguntas sobre cómo planeas usarlo. También puedes conectar tu cuenta de GitHub e instalar la Aplicación de GitHub para habilitar los despliegues automáticos.
|
|
|
|
En el paso final de la configuración inicial, describe la documentación que quieres crear. Puedes agregar enlaces a tu sitio existente, subir archivos o seleccionar repositorios de GitHub para usarlos como fuentes. El agente de Mintlify genera un punto de partida para tu documentación mientras observas una vista previa en vivo. Responde las preguntas que haga el agente para refinar el resultado. Para comenzar con contenido de ejemplo, selecciona **Skip, start from a blank template**.
|
|
|
|
Después de la configuración inicial, tu sitio de documentación se despliega y queda accesible en tu URL `.mintlify.site`.
|
|
|
|
<Accordion title="Opcional: omitir la conexión con un proveedor de Git durante la configuración inicial">
|
|
Si quieres comenzar rápidamente sin conectar tu propio repositorio, puedes omitir la conexión con un proveedor de Git durante la configuración inicial.
|
|
|
|
Esto te permite usar el editor web de inmediato. Si deseas usar tu propio repositorio más adelante, ve a [Git Settings](https://app.mintlify.com/settings/deployment/git-settings) en tu dashboard para migrar tu contenido usando el asistente de configuración de Git. Consulta [Clonar en tu propio repositorio](/es/deploy/github#clone-to-your-own-repository) para más detalles.
|
|
</Accordion>
|
|
</Visibility>
|
|
|
|
<Visibility for="agents">
|
|
Usa el flujo de configuración de la CLI anterior. La verificación de la cuenta y la autorización de GitHub abren páginas del navegador que el usuario debe aprobar. Debes iniciar el comando correspondiente `mint signup` o `mint login` y continuar la configuración cuando termine. No consideres que la configuración está completa hasta que `mint status` indique un subdominio y se cargue la URL `.mintlify.site` desplegada.
|
|
</Visibility>
|
|
|
|
<div id="view-your-deployed-site">
|
|
## Consulta tu sitio desplegado
|
|
</div>
|
|
|
|
Tu sitio de documentación ya se ha desplegado en `https://<your-project-name>.mintlify.site`.
|
|
|
|
Encuentra tu URL exacta en la página **Overview** de tu [Dashboard de Mintlify](https://dashboard.mintlify.com/).
|
|
|
|
<Frame>
|
|
<img src="/images/quickstart/mintlify-domain-light.png" alt="Página Overview del Dashboard de Mintlify." className="block dark:hidden" />
|
|
|
|
<img src="/images/quickstart/mintlify-domain-dark.png" alt="Página Overview del Dashboard de Mintlify." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
<Tip>
|
|
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](/es/customize/custom-domain).
|
|
</Tip>
|
|
|
|
<div id="make-your-first-change">
|
|
## Haz tu primer cambio
|
|
</div>
|
|
|
|
<Tabs>
|
|
<Tab title="CLI">
|
|
<Steps>
|
|
<Step title="Instala la CLI">
|
|
La CLI requiere [Node.js](https://nodejs.org/en) v20.17.0 o superior. Usa una versión LTS para mayor estabilidad.
|
|
|
|
<CodeGroup>
|
|
```bash npm
|
|
npm i -g mint
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm add -g mint
|
|
```
|
|
</CodeGroup>
|
|
|
|
Consulta [Instalar la CLI](/es/cli/install) para ver todos los detalles y la resolución de problemas.
|
|
</Step>
|
|
|
|
<Step title="Clona tu repositorio">
|
|
Si aún no has clonado tu repositorio localmente, clónalo usando Git:
|
|
|
|
```bash
|
|
git clone <your-repository-url>
|
|
```
|
|
|
|
Si tu repositorio está en la organización privada de Mintlify, consulta [Clonar en tu propio repositorio](/es/deploy/github#clone-to-your-own-repository) para moverlo primero a tu cuenta.
|
|
</Step>
|
|
|
|
<Step title="Edita una página">
|
|
Abre `index.mdx` en tu editor preferido y actualiza el campo `description` en el frontmatter:
|
|
|
|
```mdx
|
|
---
|
|
title: "Introduction"
|
|
description: "Your custom description here"
|
|
---
|
|
```
|
|
</Step>
|
|
|
|
<Step title="Vista previa local">
|
|
Ejecuta el siguiente comando desde tu directorio de documentación:
|
|
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
Ve la vista previa en `http://localhost:3000`.
|
|
</Step>
|
|
|
|
<Step title="Haz push de tus cambios">
|
|
Crea una confirmación (commit) y haz push de tus cambios para iniciar una implementación:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
|
|
Mintlify despliega automáticamente tus cambios. Consulta el estado del despliegue en la página de [Overview](https://dashboard.mintlify.com/) de tu dashboard.
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
|
|
<Tab title="Editor web">
|
|
<Steps>
|
|
<Step title="Abre el editor web">
|
|
Navega al [editor web](https://dashboard.mintlify.com/editor) en tu dashboard.
|
|
</Step>
|
|
|
|
<Step title="Edita una página">
|
|
Abre la página **Introduction** y actualiza la descripción.
|
|
|
|
<Frame>
|
|
<img src="/images/quickstart/hello-world-light.png" alt="Página Introduction abierta en el editor web con la descripción editada para que diga Hello world!" className="block dark:hidden" />
|
|
|
|
<img src="/images/quickstart/hello-world-dark.png" alt="Página Introduction abierta en el editor web con la descripción editada para que diga Hello world!" className="hidden dark:block" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="Publicar">
|
|
Haz clic en el botón **Publish** en la esquina superior derecha de la barra de herramientas del editor web.
|
|
</Step>
|
|
|
|
<Step title="Ver en vivo">
|
|
En la página de [Overview](https://dashboard.mintlify.com/) de tu dashboard, puedes ver el estado del despliegue de tu sitio. Cuando el despliegue haya finalizado, actualiza tu sitio de documentación para ver tus cambios en vivo.
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<div id="next-steps">
|
|
## Próximos pasos
|
|
</div>
|
|
|
|
<Card title="Usar el editor web" icon="mouse-pointer-2" horizontal href="/es/editor/index">
|
|
Edita la documentación en tu navegador y obtén una vista previa de cómo se ven tus páginas al publicarlas.
|
|
</Card>
|
|
|
|
<Card title="Conectar el MCP de búsqueda" icon="search" horizontal href="/es/ai/model-context-protocol">
|
|
Conecta herramientas de IA como Claude, Cursor y ChatGPT a tu servidor MCP de búsqueda para que puedan buscar y recuperar contenido de tu sitio de forma eficiente.
|
|
</Card>
|
|
|
|
<Card title="Explorar comandos de la CLI" icon="terminal" horizontal href="/es/cli/index">
|
|
Encuentra enlaces rotos, verifica la accesibilidad, valida especificaciones de OpenAPI y más.
|
|
</Card>
|
|
|
|
<Card title="Agregar un dominio personalizado" icon="globe" horizontal href="/es/customize/custom-domain">
|
|
Usa tu propio dominio para tu sitio de documentación.
|
|
</Card> |