Migrar a Mintlify

Migra tu documentación usando el paquete @mintlify/scraping. El paquete extrae tu contenido y lo convierte para usar componentes de Mintlify.

Plataformas compatiblesCopy Anchor Link

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

Instalación del scraperCopy Anchor Link

Instala el paquete @mintlify/scraping para empezar.

npm install @mintlify/scraping@latest -g

Extracción de páginas y seccionesCopy Anchor Link

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.

Migrar especificaciones OpenAPI:

mintlify-scrape openapi-file [openApiFilename]

Añade el contenido preparado a tu proyecto de MintlifyCopy Anchor Link

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.

Mintlify puede generar un sitio de documentación completo para cualquier repositorio público de GitHub, ya sea que contenga documentación o solo código.

Reemplaza github.com por mintlify.com en la URL de cualquier repositorio público:

https://mintlify.com/github-owner/repository-name

Mintlify analiza tu repositorio y genera un sitio de documentación completo que luego puedes personalizar.

Migra tu documentación desde cualquier plataforma con control total sobre el proceso.

Migración de contenidoCopy Anchor Link

Para migrar tu contenido a Mintlify, necesitas:

• Un docs.json válido para la configuración de tu sitio y la navegación. Consulta Configuración global y Navegación para más información.
• Un archivo Markdown (.md o .mdx) para cada página de tu documentación. MDX es el formato recomendado. Consulta Páginas para más información.
• (Opcional) Una especificación de OpenAPI para las páginas de endpoints de tu API. Consulta Configuración de OpenAPI para más información.

1. Si tu contenido ya está en formato Markdown, copia el contenido a tu proyecto de Mintlify. De lo contrario, convierte tu contenido al formato MDX.
2. Crea tu docs.json haciendo referencia a las rutas de tus páginas Markdown.
3. Si tienes especificaciones OpenAPI, añádelas a tu docs.json y configura el área de pruebas de la API. También puedes generar páginas MDX a partir de tu especificación usando el paquete @mintlify/scraping:

npx @mintlify/scraping@latest openapi-file <openApiFilename> -o <folder-name>

Migración de recursosCopy Anchor Link

1. Copia los recursos al directorio images/ de tu repositorio.
2. Actualiza las referencias en tus archivos Markdown:

   Copy Text

   ![Alt text](/images/screenshot.png)