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.
Migra tu documentación con el paquete @mintlify/scraping. El paquete extrae tu contenido y lo convierte para usar Componentes (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. De forma predeterminada, los archivos preparados se almacenan localmente en ./docs.Para sitios de documentación grandes, migra secciones más pequeñas por partes en lugar de todo el sitio de una sola vez.Migrar secciones completas:
mintlify-scrape sección https://tu-sitio-de-docs.com/docs
Migrar páginas individuales:
mintlify-scrape page https://tu-sitio-de-docs.com/docs/getting-started
Migra especificaciones OpenAPI:
mintlify-scrape archivo-openapi [nombreDeArchivoOpenAPI]

​
Agrega contenido predefinido a tu proyecto de Mintlify

Después de rastrear tu plataforma de documentación existente, ya estás listo para crear 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 la migración (automatizada o manual), te recomendamos verificar:
  • Todas las páginas se renderizan
  • La navegación funciona como se espera
  • Los enlaces internos se resuelven correctamente
  • Las imágenes y los archivos estáticos se cargan correctamente
  • Los bloques de código se muestran con el resaltado de sintaxis adecuado
  • La búsqueda funciona
  • El despliegue está configurado
  • El dominio personalizado está configurado