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 del 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 usando 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

​
Extracción de 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.Para sitios de documentación grandes, migra secciones más pequeñas de forma gradual en lugar de migrar todo el sitio de una sola vez.Migrar secciones completas:
mintlify-scrape section https://your-docs-site.com/docs
Migrar páginas individuales:
mintlify-scrape page https://your-docs-site.com/docs/getting-started
Migrar especificaciones de OpenAPI:
mintlify-scrape openapi-file [nombreArchivoOpenApi]

​
Añade contenido preparado a tu proyecto de Mintlify

Después de extraer el contenido de tu plataforma de documentación existente, estás listo para crear tu documentación en Mintlify.Confirma que todas tus páginas han sido migradas y luego añade estos archivos al repositorio de documentación que creaste durante el proceso de configuración inicial. Normalmente se trata de un repositorio de GitHub.

​
Lista de verificación posterior a la migración

Después de completar tu migración (automática o manual), te recomendamos verificar:
  • Que todas las páginas se rendericen
  • Que la navigation funcione como se espera
  • Que los enlaces internos se resuelvan correctamente
  • Que las imágenes y los recursos se carguen correctamente
  • Que los bloques de código se muestren con el resaltado de sintaxis adecuado
  • Que la búsqueda funcione
  • Que la implementación esté configurada
  • Que el dominio personalizado esté configurado
⌘I