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 parcours de migration

Migration automatisée

Si vous migrez depuis Docusaurus, ReadMe ou GitBook, utilisez nos outils pour automatiser votre migration.

Migration manuelle

Si vous migrez depuis une autre plateforme, suivez notre guide pour migrer votre contenu.
  • Migration automatisée
  • Migration manuelle
Migrez votre documentation à l’aide du package @mintlify/scraping. Ce package aspire votre contenu et le convertit pour utiliser les composants Mintlify.

Plates-formes 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

Scraper des pages et des sections

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

Ajoutez du contenu préconfiguré à votre projet Mintlify

Après avoir aspiré 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 dépôt de documentation que vous avez créé lors de l’onboarding. Il s’agit généralement d’un dépôt 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
  • Le déploiement est correctement configuré
  • Le domaine personnalisé est correctement configuré