Migrer vers Mintlify

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 chargeCopy Anchor Link

Si vous hébergez votre documentation sur une autre plateforme, consultez les étapes de migration manuelle.

Installation du scraperCopy Anchor Link

Installez le package @mintlify/scraping pour commencer.

npm install @mintlify/scraping@latest -g

Extraction de pages et de sectionsCopy Anchor Link

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.

Migrer les spécifications OpenAPI :

mintlify-scrape openapi-file [openApiFilename]

Ajouter le contenu préparé à votre projet MintlifyCopy Anchor Link

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.

Mintlify peut générer un site de documentation complet pour n’importe quel référentiel GitHub public, qu’il contienne déjà de la documentation ou uniquement du code.

Remplacez github.com par mintlify.com dans n’importe quelle URL de référentiel public :

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

Mintlify analyse votre référentiel et génère un site de documentation complet que vous pourrez ensuite personnaliser.

Migrez votre documentation depuis n’importe quelle plateforme en gardant un contrôle total sur le processus.

Migration du contenuCopy Anchor Link

Pour migrer votre contenu vers Mintlify, vous aurez besoin de :

• D’un docs.json valide pour les paramètres de votre site et la navigation. Voir Paramètres globaux et Navigation pour plus d’informations.
• D’un fichier Markdown (.md ou .mdx) pour chaque page de votre documentation. MDX est le format recommandé. Voir Pages pour plus d’informations.
• (Facultatif) D’une spécification OpenAPI pour les pages d’endpoints de votre API. Voir OpenAPI setup pour plus d’informations.

1. Si votre contenu est déjà au format Markdown, copiez-le dans votre projet Mintlify. Sinon, convertissez votre contenu au format MDX.
2. Créez votre docs.json en y faisant référence aux chemins vers vos pages Markdown.
3. Si vous avez des spécifications OpenAPI, ajoutez-les à votre docs.json et configurez le bac à sable d’API. Vous pouvez également générer des pages MDX à partir de votre spécification à l’aide de la commande mint scrape openapi :

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

Migration des ressourcesCopy Anchor Link

1. Copiez les ressources dans le répertoire images/ de votre référentiel.
2. Mettez à jour les références dans vos fichiers Markdown :

   Copy Text

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