> ## Documentation Index
> Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Migrar desde ReadMe

> Migra guías, referencias de API, recetas, páginas personalizadas, versiones, contenido reutilizable y recursos de ReadMe a Mintlify.

Migra un proyecto público de ReadMe con el scraper de Mintlify, o exporta los archivos del proyecto desde ReadMe cuando necesites contenido privado, especificaciones OpenAPI o múltiples versiones.

<div id="choose-a-method">
  ## Elige un método
</div>

| Método                        | Cuándo usarlo                                                                                                                                               |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Scraper                       | Todo tu sitio de ReadMe es público y quieres la conversión más rápida de las páginas renderizadas y la navegación.                                          |
| Exportación en ZIP o a GitHub | Puedes acceder a tu proyecto de ReadMe y necesitas páginas privadas, archivos OpenAPI, páginas personalizadas, recetas o varias versiones de documentación. |
| API de ReadMe                 | Necesitas datos que tu exportación de archivos no incluye, como imágenes alojadas u otros datos del proyecto.                                               |

Para una migración completa, empieza con una exportación nativa y utiliza un scrape de tu sitio público como comparación. Los dos inventarios ayudan a descubrir las páginas no publicadas y el contenido que no tiene una representación en archivo.

<div id="export-from-readme">
  ## Exportar desde ReadMe
</div>

Desde el menú de rama en ReadMe, exporta los archivos de documentación como un ZIP. ReadMe envía la exportación completada por correo electrónico. La estructura del proyecto exportado puede incluir guías, recetas, páginas personalizadas, bloques personalizados, contenido de API Reference y archivos OpenAPI, pero no incluye los archivos de imagen en sí.

Si tu proyecto usa la integración de GitHub de ReadMe, puedes exportar tu proyecto a un repositorio. ReadMe documenta que el repositorio contiene el mismo contenido que una exportación de rama y puede incluir todas las versiones de la documentación.

Mantén tu exportación sin cambios como una instantánea de migración. Realiza el trabajo de conversión en una copia o en una rama de Git separada.

<Warning>
  Exporta cada versión mantenida antes de eliminar o cambiar algo en ReadMe. Además, exporta o descarga las imágenes alojadas por separado. Tu exportación de archivos preserva sus rutas, pero no los archivos de imagen.
</Warning>

<div id="migrate-a-public-site">
  ## Migrar un sitio público
</div>

<Warning>
  El scraper puede sobrescribir archivos existentes.

  Ejecuta el scraper en un directorio vacío para que no reemplace ningún archivo existente.
</Warning>

```bash theme={null}
mkdir mintlify-migration
cd mintlify-migration
npx @mintlify/scraping@latest section https://your-project.readme.io
```

Si tu sitio contiene documentación bajo una ruta o versión específica, usa un filtro para limitar la migración inicial:

```bash theme={null}
npx @mintlify/scraping@latest section https://your-project.readme.io --filter=/docs
```

El scraper convierte las páginas alcanzables, las imágenes, la navegación y los componentes renderizados comunes. No puede acceder a tu contenido privado o no publicado y no sustituye a una exportación separada de tu especificación OpenAPI fuente.

<div id="understand-your-exported-files">
  ## Comprende tus archivos exportados
</div>

La estructura de archivos de ReadMe normalmente separa el contenido por tipo.

```text theme={null}
docs/             Guías organizadas por categoría
reference/        Páginas de referencia de API y archivos OpenAPI
recipes/          Recetas paso a paso
custom_pages/     Páginas personalizadas en Markdown o HTML
custom_blocks/    Bloques personalizados reutilizables
_order.yaml       Orden dentro de una carpeta o categoría
```

Una carpeta que contenga páginas hijas puede incluir `index.md` para la página padre y `_order.yaml` para sus hijas. Traduce esa estructura a entradas anidadas de `group` y `pages` en `docs.json`. Utiliza el `index.md` padre como `root` del grupo cuando contenga contenido útil de resumen.

| ReadMe                           | Mintlify                                   |
| -------------------------------- | ------------------------------------------ |
| Categoría de guía                | Grupo de navegación                        |
| `_order.yaml`                    | Orden del array `pages`                    |
| `index.md` de una carpeta        | Página `root` del grupo                    |
| Página hija de guía o referencia | Grupo anidado o página                     |
| Versión o rama del proyecto      | Versión de navegación                      |
| Página personalizada             | Página MDX estándar o diseño personalizado |
| Página de tipo enlace            | Enlace de navegación o página que redirige |

Consulta [Navegación](/docs/es/organize/navigation) para más información sobre cómo estructurar los elementos de navegación.

<div id="convert-pages-and-frontmatter">
  ## Convertir páginas y frontmatter
</div>

Conserva `title`, los metadatos SEO, las descripciones y las palabras clave útiles. Convierte los campos específicos de ReadMe.

| Frontmatter de ReadMe                     | Tratamiento en Mintlify                                                                                                                                                                             |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `excerpt`                                 | Úsalo como `description` de la página.                                                                                                                                                              |
| `hidden: true`                            | Deja la página fuera de la navegación y revisa si debe seguir siendo accesible.                                                                                                                     |
| `deprecated: true`                        | Añade un aviso de obsolescencia a la página.                                                                                                                                                        |
| `metadata.title` y `metadata.description` | Compáralos con el `title` visible y el `excerpt`. Decide qué valores usar para el `title` y la `description` de Mintlify, y utiliza los campos de Open Graph solo para las vistas previas sociales. |
| `metadata.robots: noindex`                | Establece `noindex: true`.                                                                                                                                                                          |
| `next.pages`                              | Añade enlaces explícitos o tarjetas de páginas relacionadas donde ayuden al lector.                                                                                                                 |
| `icon` con clases de Font Awesome         | Sustitúyelo por un nombre de icono compatible de Font Awesome, Lucide o Tabler.                                                                                                                     |

ReadMe admite un dialecto de Markdown personalizado y bloques mágicos basados en JSON. El scraper convierte los componentes renderizados comunes, pero las exportaciones de archivos pueden conservar la sintaxis de la plataforma. Revisa los siguientes patrones para identificar contenido que debe convertirse.

* Callouts, pestañas, acordeones, tarjetas y grupos de código
* Contenido reutilizable y bloques personalizados
* Variables y términos del glosario
* Recetas interactivas
* Páginas HTML personalizadas
* Exploradores de API integrados y contenido personalizado

Convierte el material reutilizable en [snippets de Mintlify](/docs/es/create/reusable-snippets). Tu exportación podría expandir un bloque reutilizable en cada página, así que compara las copias y consolida solo el contenido idéntico.

<div id="migrate-api-reference-content">
  ## Migrar contenido de referencia de API
</div>

Prefiere tu archivo OpenAPI original a las páginas de endpoints renderizadas o exportadas.

1. Encuentra cada archivo OpenAPI en JSON o YAML en `reference/` y en cualquier repositorio fuente que hayas usado con `rdme` o con la sincronización de API de ReadMe.
2. Identifica el Markdown que los editores añadieron en ReadMe fuera de la especificación. ReadMe asocia este contenido con una operación por su `operationId`.
3. Añade la especificación a tu repositorio de Mintlify y configura las [páginas generadas a partir de OpenAPI](/docs/es/api-playground/openapi-setup).
4. Traslada el Markdown complementario valioso a la descripción de la operación correspondiente, la descripción del esquema o una guía adyacente.
5. Compara la autenticación, las URL de servidor, los ejemplos de código, los ejemplos y el orden de los endpoints con tu referencia original.

ReadMe también puede ingerir Swagger 2.0 y colecciones de Postman. Recupera la fuente OpenAPI convertida u original antes de configurar Mintlify en lugar de copiar la referencia renderizada.

<div id="migrate-your-versions">
  ## Migrar tus versiones
</div>

Las versiones y ramas de ReadMe se aplican al contenido de Guías, Recetas y API Reference, mientras que parte del contenido de tu proyecto permanece compartido entre versiones. Inventaría cada versión por separado y asocia las versiones mantenidas a la [navegación de versiones](/docs/es/organize/navigation#versions) de Mintlify.

Revisa los siguientes patrones.

* Una versión predeterminada distinta y su comportamiento de URL
* Versiones ocultas, beta y obsoletas
* Contenido reutilizable específico de una versión
* Páginas que existen solo en una versión
* Especificaciones de API que difieren según la versión
* Páginas personalizadas o contenido de changelog compartidos

<div id="download-images-and-files">
  ## Descargar imágenes y archivos
</div>

Tu exportación ZIP de ReadMe no contiene las imágenes alojadas. Usa las URL de imagen en tu exportación o la API de ReadMe para descargar los archivos originales y, después, añádelos a tu repositorio de Mintlify.

No dependas de las URL de recursos remotos de ReadMe para tu sitio final. Copia los archivos que te pertenezcan, actualiza sus referencias y verifica el texto alternativo y los enlaces a archivos descargables.

<div id="preserve-urls">
  ## Conservar las URL
</div>

Tus URL de ReadMe pueden incluir la versión del proyecto y el tipo de contenido, como `/docs/`, `/reference/` o `/page/`. Exporta un sitemap o rastrea tu sitio publicado para capturar las rutas reales.

Añade [redirecciones](/docs/es/create/redirects) para cada ruta que cambie. Presta especial atención a:

* URL de la versión predeterminada que omiten el segmento de versión
* Páginas personalizadas bajo `/page`
* Guías y páginas de referencia con el mismo slug
* Rutas de endpoint derivadas de las etiquetas y resúmenes de OpenAPI
* Páginas obsoletas u ocultas que aún reciben tráfico

<div id="review-your-migration">
  ## Revisa tu migración
</div>

Compara tu exportación en ZIP, el inventario obtenido por API y el sitemap publicado con tus archivos migrados, y previsualiza cada versión mantenida.

Busca en tus archivos convertidos restos de sintaxis de ReadMe: bloques mágicos, variables, referencias al glosario y directivas de Custom Block.

## Lanza tu nuevo sitio

* Establece una congelación de contenido en tu sitio anterior y registra cada cambio que se le realice después de la instantánea de migración.
* Confirma tu rama y repositorio de producción en la página de [ajustes de Git](https://app.mintlify.com/settings/deployment/git-settings) de tu panel.
* Anota tus registros DNS actuales y mantén tu sitio anterior en funcionamiento hasta que verifiques que tu despliegue de Mintlify está en producción.
* Revisa la barra de navegación, el pie de página, el favicon, el logotipo, los colores y la tipografía.
* Revisa los metadatos del sitio y de las páginas, las URL canónicas y las preferencias de indexación. Consulta [SEO y ajustes de búsqueda](/docs/es/organize/settings-seo).
* Instala las [integraciones de analítica](/docs/es/integrations/analytics/overview) necesarias y, opcionalmente, añade una [página 404 personalizada](/docs/es/customize/custom-404-page).
* Si migraste una referencia de API, compara las páginas de endpoints, la estructura de navegación, las URL de servidor, los esquemas de autenticación y los ejemplos con tu sitio anterior.
* Previsualiza tu commit exacto de lanzamiento en un [despliegue de previsualización](/docs/es/deploy/preview-deployments). Comprueba los diseños en escritorio y móvil, páginas de cada sección de navegación, la búsqueda y tus redirecciones.
* Revisa la consola del navegador y la pestaña de red por si hay errores en páginas que utilicen componentes o scripts personalizados.
* Cambia tu dominio siguiendo la [guía de dominio personalizado](/docs/es/customize/custom-domain), que cubre la migración sin tiempo de inactividad para un dominio que ya sirve documentación.
* Tras el lanzamiento, monitorea los errores 404, los fallos de redirección y los fallos de compilación.

<div id="readme-references">
  ## Referencias de ReadMe
</div>

* [Exportar datos](https://docs.readme.com/main/docs/exporting-data)
* [Estructura de la documentación](https://docs.readme.com/main/docs/documentation-structure)
* [Versionado](https://docs.readme.com/main/docs/versions)
* [Compatibilidad con OpenAPI](https://docs.readme.com/main/docs/openapi)
* [Contenido reutilizable](https://docs.readme.com/main/docs/reusable-content)


## Related topics

- [Descripción general de la migración](/docs/es/migration/index.md)
- [Migrar desde GitBook](/docs/es/migration/gitbook.md)
- [Migrar desde Document360](/docs/es/migration/document360.md)
