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

  • Si actualmente usas Docusaurus o ReadMe -> Migración automatizada
  • Si tienes un repositorio público en GitHub -> Migración generada automáticamente
  • Si estás migrando desde cualquier otra plataforma -> 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

Si alojas tu documentación 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. Guarda los archivos preparados localmente en la carpeta ./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
Filtrar rutas específicas:Usa la opción --filter (o -f) para extraer solo las URL que coincidan con un prefijo de ruta específico.
mintlify-scrape section https://your-docs-site.com --filter=/docs
El filtro coincide con la ruta especificada y todas las rutas anidadas. Por ejemplo, --filter=/docs coincide con /docs, /docs/getting-started, /docs/api/reference, etc.También puedes usar el comando CLI:
mint scrape site https://your-docs-site.com --filter=/docs
Migrar especificaciones OpenAPI:
mintlify-scrape openapi-file [openApiFilename]

​
Añade el 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 hayas extraído todas tus páginas. Luego agrega estos archivos al repositorio de documentación que creaste durante el proceso de incorporación. Por lo general, este es 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 comprobar:
  • Todas las páginas se renderizan
  • La navigation funciona como se espera
  • Los enlaces internos se resuelven correctamente
  • Las imágenes y los recursos cargan correctamente
  • Los bloques de código se muestran con el resaltado de sintaxis adecuado
  • La búsqueda funciona
  • Rama de implementación correcta