Saltar al contenido principal
Esta guía te ayuda a trasladar tu documentación existente a Mintlify. Elige la migración automatizada para las plataformas compatibles o la migración manual para tener control total sobre el proceso.

Elige tu ruta de migración

Migración automatizada

Si migras desde Docusaurus, ReadMe o GitBook, usa nuestras herramientas para automatizar la migración.

Migración manual

Si migras desde cualquier otra plataforma, sigue nuestra guía para migrar tu contenido.
  • Migración automatizada
  • Migración manual
Migra tu documentación con el paquete @mintlify/scraping. El paquete extrae tu contenido y lo convierte para usar componentes de Mintlify.

Plataformas compatibles

Docusaurus

ReadMe

GitBook (beta)

Si tu documentación está alojada en otra plataforma, consulta los pasos de migración manual.

Instalación del scraper

Instala el paquete @mintlify/scraping para empezar.
npm install @mintlify/scraping@latest -g

Rastrear páginas y secciones

La herramienta de migración detecta automáticamente tu plataforma de documentación y convierte tu contenido. Los archivos preparados se almacenan localmente en ./docs de forma predeterminada.En sitios de documentación grandes, migra secciones pequeñas por etapas en lugar de todo el sitio de una sola vez.Migrar secciones completas:
mintlify-scrape sección https://your-docs-site.com/docs
Migrar páginas individuales:
mintlify-scrape page https://tu-sitio-de-docs.com/docs/getting-started
Migrar las especificaciones de OpenAPI:
mintlify-scrape openapi-file [nombreArchivoOpenAPI]

Agrega contenido preconfigurado a tu proyecto de Mintlify

Después de rastrear tu plataforma de documentación actual, ya puedes construir tu documentación en Mintlify.Confirma que todas tus páginas se hayan migrado y luego agrega estos archivos al repositorio de documentación que creaste durante la incorporación. Por lo general, es un repositorio de GitHub.

Lista de verificación posterior a la migración

Después de completar tu migración (automatizada o manual), te recomendamos verificar:
  • Todas las páginas se renderizan
  • La navegación funciona como se espera
  • Los enlaces internos funcionan correctamente
  • Las imágenes y los recursos cargan correctamente
  • Los bloques de código muestran el resaltado de sintaxis correcto
  • La búsqueda funciona
  • El despliegue está configurado
  • El dominio personalizado está configurado