Saltar al contenido principal
Esta guía te ayuda a trasladar tu documentación 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 o ReadMe, utiliza 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 automática
  • Migración manual
Migra tu documentación utilizando el paquete @mintlify/scraping. El paquete extrae tu contenido y lo convierte para utilizar componentes de Mintlify.

Plataformas compatibles

Docusaurus

Léeme

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 comenzar.
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 el 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 progresiva en lugar de migrar todo el sitio de una sola vez.Migra secciones completas:
mintlify-scrape section https://your-docs-site.com/docs
Migra páginas individuales:
mintlify-scrape page https://your-docs-site.com/docs/getting-started
Migra las especificaciones 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 se han migrado y luego añade estos archivos al repositorio de documentación que creaste durante el proceso de incorporación. Normalmente, este 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 comprobar:
  • Todas las páginas se renderizan
  • La navigation funciona según lo previsto
  • Los enlaces internos se resuelven correctamente
  • Las imágenes y los recursos se cargan correctamente
  • Los bloques de código se muestran con el resaltado de sintaxis adecuado
  • La búsqueda funciona
  • La implementación está configurada
  • El dominio personalizado está configurado