Passer au contenu principal
Ce guide vous aide à migrer votre documentation existante vers Mintlify. Optez pour une migration automatisée pour les plateformes prises en charge, ou pour une migration manuelle afin de garder un contrôle total sur le processus.

Choisissez votre méthode de migration

Migration automatisée

Si vous passez de Docusaurus, ReadMe ou GitBook à Mintlify, utilisez nos outils pour automatiser la migration.

Migration manuelle

Si vous venez d’une autre plateforme, suivez notre guide pour migrer votre contenu.
  • Migration automatisée
  • Migration manuelle
Migrez votre documentation en utilisant le package @mintlify/scraping. Ce package extrait votre contenu et le convertit pour utiliser les composants Mintlify.

Plateformes prises en charge

Docusaurus

ReadMe

GitBook (bêta)

Si votre documentation est hébergée sur une autre plateforme, consultez les étapes de migration manuelle.

Installation du scraper

Installez le package @mintlify/scraping pour commencer.
npm install @mintlify/scraping@latest -g

Extraction de pages et de sections

L’outil de migration détecte automatiquement votre plateforme de documentation et convertit votre contenu. Les fichiers préparés sont stockés localement dans ./docs par défaut.Pour les sites de documentation volumineux, migrez de petites sections à la fois plutôt que l’ensemble du site en une seule fois.Migrer des sections entières :
mintlify-scrape section https://your-docs-site.com/docs
Migrer des pages individuelles :
mintlify-scrape page https://your-docs-site.com/docs/getting-started
Migrer les spécifications OpenAPI :
mintlify-scrape openapi-file [nomFichierOpenApi]

Ajouter le contenu préparé à votre projet Mintlify

Après avoir extrait le contenu de votre plateforme de documentation existante, vous êtes prêt à créer votre documentation sur Mintlify.Confirmez que toutes vos pages ont été migrées, puis ajoutez ces fichiers au référentiel de documentation que vous avez créé lors du processus d’intégration. Il s’agit généralement d’un référentiel GitHub.

Liste de contrôle post‑migration

Après avoir terminé votre migration (automatisée ou manuelle), nous vous recommandons de vérifier :
  • Toutes les pages s’affichent
  • La navigation fonctionne comme prévu
  • Les liens internes pointent correctement
  • Les images et les ressources se chargent correctement
  • Les code blocks s’affichent avec une coloration syntaxique appropriée
  • La recherche fonctionne
  • Le déploiement est configuré
  • Le domaine personnalisé est configuré
I