Migrer vers GitBook

Comment importer du contenu existant dans GitBook depuis Confluence, Notion, Git et plus encore

Vous pouvez migrer et unifier la documentation existante dans GitBook à l’aide de l’outil d’importation.

Vous avez la possibilité d’importer des pages individuelles ou multiples à l’aide de notre outil d’importation intégré — ou un dépôt Git entier à l’aide de Git Sync.

Utilisation du panneau d’importation

Le panneau d’importation facilite la migration de votre contenu vers votre organisation GitBook depuis un autre site de documentation ou depuis des fichiers existants.

Lorsque vous choisissez d’importer depuis un autre site de documentation en ligne, il vous suffit d’ajouter l’URL du site et GitBook s’occupe du reste.

Par défaut, GitBook utilise l’IA pour simplifier le processus d’importation. Celle-ci affinera et nettoiera intelligemment le contenu importé qui ne correspond pas parfaitement aux formats de GitBook — ce qui signifie que le résultat sera plus soigné et utilisera plus efficacement les blocs GitBook. Vous pouvez désactiver cette option depuis le menu.

Formats d’importation pris en charge

GitBook prend en charge les importations depuis des sites de documentation ou des fichiers aux formats suivants :

• Markdown (.md ou .markdown)

• HTML (.html)

• Microsoft Word (.docx)

GitBook prend également en charge les importations depuis :

• Confluence

• Notion

• GitHub Wiki

• Quip

• Dropbox Paper

• Google Docs

Si vous souhaitez importer plusieurs pages, vous pouvez téléverser un fichier ZIP contenant des fichiers HTML ou Markdown, ou utiliser l’option Documentation en ligne d’importation.

GitBook est basé sur Markdown, donc l’importation de contenu au format Markdown donnera les meilleurs résultats. Si vos outils actuels prennent en charge l’exportation en Markdown, nous vous recommandons d’utiliser ce format pour un processus d’importation plus fluide.

Le panneau d’importation

Le panneau d’importation dans GitBook.

Lorsque vous créez un nouvel espace, vous aurez la possibilité d’importer du contenu dans la fenêtre modale qui apparaît. Si vous créez un espace vide, vous pouvez également importer à l’aide de la Démarrage rapide section en bas de la nouvelle page vide lorsque vous cliquez sur Modifier.

Sinon, vous pouvez toujours importer une page ou une sous-page en sélectionnant Ajouter nouveau > Importer des pages en bas de la table des matières, ou en ouvrant le menu Actions pour une page et en choisissant Importer des sous-pages.

Après avoir choisi une source d’entrée, vous pouvez sélectionner le fichier que vous souhaitez importer.

GitBook importe du contenu depuis diverses sources, mais les différences entre les fonctionnalités du produit et les formats de document peuvent entraîner des variations dans le contenu importé par rapport à la source d’origine.

Limitations

GitBook impose actuellement les limites suivantes pour le contenu importé :

• Le nombre maximal de pages pouvant être téléversées lors d’une seule importation est 20.

• Le nombre maximal de fichiers (images, etc.) pouvant être téléversés lors d’une seule importation est 20.

---

Importer depuis un dépôt GitHub ou GitLab à l’aide de Git Sync

Lorsque vous importez de grands volumes de contenu dans GitBook, nous vous recommandons d’utiliser Synchronisation Git. Bien que notre outil de migration intégré puisse gérer la plupart des importations, Git Sync est mieux adapté pour gérer efficacement des migrations plus volumineuses.

Vous trouverez ci-dessous les étapes essentielles pour importer votre contenu. Pour des étapes plus détaillées et une démonstration vidéo, consultez notre guide dédié à l’importation de contenu dans GitBook à l’aide de Git Sync.

1

Convertissez votre contenu en Markdown

GitBook est basé sur Markdown, donc l’importation de contenu au format Markdown donnera les meilleurs résultats. Si vos outils actuels prennent en charge l’exportation en Markdown, nous vous recommandons d’utiliser ce format pour un processus d’importation plus fluide.

Si votre contenu n’est pas déjà dans des fichiers Markdown, nous vous recommandons d’utiliser un script (comme Markitdown) ou un outil en ligne pour convertir votre contenu.

2

Organisez votre contenu dans GitHub ou GitLab

Lors de la configuration de votre site GitBook, il est essentiel d’organiser efficacement votre contenu dans votre dépôt GitHub ou GitLab. Comme Git Sync s’effectue au niveau de l’espace, planifiez soigneusement la manière de regrouper votre contenu. Créez plusieurs dépôts ou dossiers, en veillant à ce que les fichiers Markdown nécessaires se trouvent aux bons emplacements.

3

Configurez les espaces et Git Sync

Pour organiser votre contenu, créez un ou plusieurs espaces dans GitBook selon vos besoins. Installez les intégrations Synchronisation GitHub ou GitLab Sync dans votre organisation et configurez-les pour ces espaces. Vous devrez synchroniser votre espace avec le dossier ou le dépôt que vous avez configuré à l’étape précédente.

4

Exécutez Git Sync dans la direction GitHub → GitBook

Lors du processus de configuration, assurez-vous de sélectionner la direction GitHub → GitBook. Cela entraînera l’importation du contenu de votre dossier ou dépôt depuis GitHub ou GitLab vers GitBook.