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 une migration manuelle pour un contrôle complet du processus.

​
Choisissez votre parcours de migration

  • Si vous utilisez actuellement Docusaurus ou ReadMe -> Migration automatisée
  • Si vous avez un référentiel GitHub public -> Migration générée automatiquement
  • Si vous migrez depuis toute autre plateforme -> 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

Si vous hébergez votre documentation 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 enregistrés localement dans le dossier ./docs par défaut.Pour les sites de documentation volumineux, migrez des sections plus petites progressivement plutôt que l’ensemble du site d’un seul coup.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
Filtrer des chemins spécifiques :Utilisez l’option --filter (ou -f) pour extraire uniquement les URL correspondant à un préfixe de chemin spécifique.
mintlify-scrape section https://your-docs-site.com --filter=/docs
Le filtre correspond au chemin spécifié et à tous les chemins imbriqués. Par exemple, --filter=/docs correspond à /docs, /docs/getting-started, /docs/api/reference, etc.Vous pouvez également utiliser la commande CLI :
mint scrape site https://your-docs-site.com --filter=/docs
Migrer les spécifications OpenAPI :
mintlify-scrape openapi-file [openApiFilename]

​
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.Vérifiez que vous avez bien extrait toutes vos pages. Ajoutez ensuite ces fichiers au référentiel de documentation que vous avez créé lors de la configuration initiale. 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 blocs de code s’affichent avec une coloration syntaxique appropriée
  • La recherche fonctionne
  • La branche de déploiement est correcte