> ## Documentation Index
> Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Migrer depuis ReadMe
> Migrez les guides ReadMe, les références API, les recettes, les pages personnalisées, les versions, le contenu réutilisable et les ressources vers Mintlify.
Migrez un projet ReadMe public avec le scraper Mintlify, ou exportez les fichiers du projet depuis ReadMe lorsque vous avez besoin de contenu privé, de spécifications OpenAPI ou de plusieurs versions.
## Choisir une méthode
| Méthode | À utiliser quand |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Scraper | Votre site ReadMe complet est public et vous souhaitez la conversion la plus rapide des pages rendues et de la navigation. |
| Export ZIP ou GitHub | Vous pouvez accéder à votre projet ReadMe et vous avez besoin de pages privées, de fichiers OpenAPI, de pages personnalisées, de recettes ou de plusieurs versions de documentation. |
| API ReadMe | Vous avez besoin de données que votre export de fichiers n'inclut pas, comme des images hébergées ou d'autres données de projet. |
Pour une migration complète, commencez par un export natif et utilisez un scrape de votre site public à titre de comparaison. Les deux inventaires aident à révéler vos pages non publiées et le contenu qui n'a pas de représentation sous forme de fichier.
## Exporter depuis ReadMe
Depuis le menu des branches dans ReadMe, exportez les fichiers de documentation au format ZIP. ReadMe envoie l'export terminé par e-mail. La structure de projet exportée peut inclure des guides, des recettes, des pages personnalisées, des blocs personnalisés, du contenu de référence API et des fichiers OpenAPI, mais elle n'inclut pas les fichiers image eux-mêmes.
Si votre projet utilise l'intégration GitHub de ReadMe, vous pouvez exporter votre projet vers un référentiel. ReadMe indique que le référentiel contient le même contenu qu'un export de branche et peut inclure toutes les versions de documentation.
Conservez votre export inchangé comme instantané de migration. Effectuez le travail de conversion dans une copie ou sur une branche Git distincte.
Exportez chaque version maintenue avant de supprimer ou modifier quoi que ce soit dans ReadMe. Exportez ou téléchargez également les images hébergées séparément. Votre export de fichiers préserve leurs chemins, mais pas les fichiers image.
## Migrer un site public
Le scraper peut écraser des fichiers existants.
Exécutez le scraper dans un répertoire vide afin qu'il ne remplace aucun fichier existant.
```bash theme={null}
mkdir mintlify-migration
cd mintlify-migration
npx @mintlify/scraping@latest section https://your-project.readme.io
```
Si votre site contient de la documentation sous un chemin ou une version spécifique, utilisez un filtre pour limiter la migration initiale :
```bash theme={null}
npx @mintlify/scraping@latest section https://your-project.readme.io --filter=/docs
```
Le scraper convertit les pages accessibles, les images, la navigation et les composants rendus courants. Il ne peut pas accéder à votre contenu privé ou non publié et ne remplace pas un export distinct de votre spécification OpenAPI source.
## Comprendre vos fichiers exportés
La structure de fichiers de ReadMe sépare généralement le contenu par type.
```text theme={null}
docs/ Guides organisés par catégorie
reference/ Pages de référence API et fichiers OpenAPI
recipes/ Recettes étape par étape
custom_pages/ Pages personnalisées Markdown ou HTML
custom_blocks/ Blocs personnalisés réutilisables
_order.yaml Ordre au sein d'un dossier ou d'une catégorie
```
Un dossier contenant des pages enfants peut inclure `index.md` pour la page parente et `_order.yaml` pour ses enfants. Traduisez cette structure en entrées `group` et `pages` imbriquées dans `docs.json`. Utilisez le `index.md` parent comme `root` du groupe lorsqu'il contient un contenu de présentation utile.
| ReadMe | Mintlify |
| --------------------------------- | ----------------------------------------------- |
| Catégorie de guide | Groupe de navigation |
| `_order.yaml` | Ordre du tableau `pages` |
| `index.md` de dossier | Page `root` de groupe |
| Guide ou page enfant de référence | Groupe imbriqué ou page |
| Version ou branche de projet | Version de navigation |
| Page personnalisée | Page MDX standard ou mise en page personnalisée |
| Page de lien | Lien de navigation ou page de redirection |
Voir [Navigation](/docs/fr/organize/navigation) pour plus d'informations sur la structuration des éléments de navigation.
## Convertir les pages et le frontmatter
Conservez `title`, les métadonnées SEO, les descriptions et les mots-clés utiles. Convertissez les champs spécifiques à ReadMe.
| Frontmatter ReadMe | Traitement Mintlify |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `excerpt` | À utiliser comme `description` de page. |
| `hidden: true` | Laissez la page en dehors de la navigation et évaluez si elle doit rester accessible. |
| `deprecated: true` | Ajoutez un avertissement de dépréciation à la page. |
| `metadata.title` et `metadata.description` | Comparez-les avec le `title` et l'`excerpt` visibles. Choisissez quelles valeurs utiliser pour les `title` et `description` Mintlify, et utilisez les champs Open Graph uniquement pour les aperçus sociaux. |
| `metadata.robots: noindex` | Définissez `noindex: true`. |
| `next.pages` | Ajoutez des liens explicites ou des cartes de pages liées lorsqu'elles aident le lecteur. |
| `icon` avec des classes Font Awesome | Remplacez par un nom d'icône Font Awesome, Lucide ou Tabler pris en charge. |
ReadMe prend en charge un dialecte Markdown personnalisé et des blocs magiques basés sur JSON. Le scraper convertit les composants rendus courants, mais les exports de fichiers peuvent conserver la syntaxe de la plateforme. Passez en revue les motifs suivants pour identifier le contenu qui doit être converti.
* Callouts, onglets, accordéons, cartes et groupes de code
* Contenu réutilisable et blocs personnalisés
* Variables et termes du glossaire
* Recettes interactives
* Pages HTML personnalisées
* Explorateurs d'API intégrés et contenu personnalisé
Convertissez le matériel réutilisable en [snippets Mintlify](/docs/fr/create/reusable-snippets). Votre export peut développer un bloc réutilisable dans chaque page, alors comparez les copies et consolidez uniquement le contenu identique.
## Migrer le contenu de référence API
Privilégiez votre fichier OpenAPI original par rapport aux pages d'endpoints rendues ou exportées.
1. Trouvez chaque fichier OpenAPI JSON ou YAML dans `reference/` et dans tout référentiel source que vous avez utilisé avec `rdme` ou la synchronisation d'API de ReadMe.
2. Identifiez le Markdown que les éditeurs ont ajouté dans ReadMe en dehors de la spécification. ReadMe associe ce contenu à une opération par son `operationId`.
3. Ajoutez la spécification à votre référentiel Mintlify et configurez des [pages générées par OpenAPI](/docs/fr/api-playground/openapi-setup).
4. Déplacez le Markdown supplémentaire pertinent dans la description de l'opération concernée, la description du schéma ou un guide adjacent.
5. Comparez l'authentification, les URL de serveur, les exemples de code, les exemples et l'ordre des endpoints avec votre référence originale.
ReadMe peut également ingérer des Swagger 2.0 et des collections Postman. Récupérez la source OpenAPI convertie ou originale avant de configurer Mintlify plutôt que de copier la référence rendue.
## Migrer vos versions
Les versions et branches ReadMe s'appliquent aux Guides, aux Recettes et au contenu de référence API, tandis qu'une partie du contenu de votre projet reste partagée entre les versions. Inventoriez chaque version séparément et mappez les versions maintenues à la [navigation par version](/docs/fr/organize/navigation#versions) Mintlify.
Recherchez les motifs suivants.
* Une version par défaut différente et un comportement d'URL différent
* Versions cachées, bêta et dépréciées
* Contenu réutilisable spécifique à une version
* Pages qui existent dans une seule version
* Spécifications API qui diffèrent selon la version
* Pages personnalisées partagées ou contenu de changelog
## Télécharger les images et les fichiers
Votre export ZIP ReadMe ne contient pas les images hébergées. Utilisez les URL d'images dans votre export ou l'API ReadMe pour télécharger les fichiers originaux, puis ajoutez-les à votre référentiel Mintlify.
Ne comptez pas sur des URL de ressources ReadMe distantes pour votre site final. Copiez les fichiers dont vous êtes propriétaire, mettez à jour leurs références et vérifiez les textes alternatifs et les liens de fichiers téléchargeables.
## Préserver les URL
Vos URL ReadMe peuvent inclure la version du projet et le type de contenu, comme `/docs/`, `/reference/` ou `/page/`. Exportez un sitemap ou explorez votre site publié pour capturer les chemins réels.
Ajoutez des [redirections](/docs/fr/create/redirects) pour chaque chemin qui change. Portez une attention particulière à :
* Les URL de la version par défaut qui omettent le segment de version
* Les pages personnalisées sous `/page`
* Les guides et pages de référence qui partagent le même slug
* Les chemins d'endpoints dérivés des tags et résumés OpenAPI
* Les pages dépréciées ou cachées qui reçoivent encore du trafic
## Vérifier votre migration
Comparez votre export ZIP, votre inventaire d'API et votre sitemap publié à vos fichiers migrés, puis prévisualisez chaque version maintenue.
Recherchez dans vos fichiers convertis toute syntaxe ReadMe résiduelle : blocs magiques, variables, références de glossaire et directives de blocs personnalisés.
## Lancez votre nouveau site
* Instaurez un gel de contenu sur votre ancien site et suivez chaque modification qui y est apportée après votre instantané de migration.
* Confirmez votre branche de production et votre référentiel sur la page [Paramètres Git](https://app.mintlify.com/settings/deployment/git-settings) de votre tableau de bord.
* Notez vos enregistrements DNS existants et gardez votre ancien site en ligne jusqu'à ce que vous ayez vérifié que votre déploiement Mintlify est actif.
* Vérifiez la barre de navigation, le pied de page, le favicon, le logo, les couleurs et la typographie.
* Vérifiez les métadonnées du site et des pages, les URL canoniques et les préférences d'indexation. Voir [Paramètres SEO et de recherche](/docs/fr/organize/settings-seo).
* Installez toutes les [intégrations d'analytique](/docs/fr/integrations/analytics/overview) requises, et ajoutez éventuellement une [page 404 personnalisée](/docs/fr/customize/custom-404-page).
* Si vous avez migré une référence API, comparez les pages d'endpoints, la structure de navigation, les URL de serveur, les schémas d'authentification et les exemples avec votre ancien site.
* Prévisualisez votre commit de lancement exact dans un [déploiement de prévisualisation](/docs/fr/deploy/preview-deployments). Vérifiez les mises en page desktop et mobile, les pages de chaque section de navigation, la recherche et vos redirections.
* Vérifiez la console du navigateur et l'onglet réseau pour détecter d'éventuelles erreurs sur les pages qui utilisent des composants ou des scripts personnalisés.
* Basculez votre domaine avec le [guide sur les domaines personnalisés](/docs/fr/customize/custom-domain), qui couvre la bascule sans interruption pour un domaine qui sert déjà de la documentation.
* Après le lancement, surveillez les erreurs 404, les échecs de redirection et les échecs de build.
## Références ReadMe
* [Exporter les données](https://docs.readme.com/main/docs/exporting-data)
* [Structure de la documentation](https://docs.readme.com/main/docs/documentation-structure)
* [Gestion des versions](https://docs.readme.com/main/docs/versions)
* [Prise en charge d'OpenAPI](https://docs.readme.com/main/docs/openapi)
* [Contenu réutilisable](https://docs.readme.com/main/docs/reusable-content)
## Related topics
- [Vue d'ensemble de la migration](/docs/fr/migration/index.md)
- [Migrer depuis GitBook](/docs/fr/migration/gitbook.md)
- [Migrer depuis Document360](/docs/fr/migration/document360.md)