Concepts
Apprenez les bases de GitBook pour pouvoir créer et publier une documentation exceptionnelle pour vos utilisateurs
Organisation du contenu
Espace
Un espace est un projet qui vous permet de travailler sur une collection de pages liées. Dans un espace, vous pouvez rédiger du contenu, organiser vos pages avec des groupes et des sous-pages, installer des intégrations, et plus encore.
Lorsque vous souhaitez publier un espace, vous pouvez le faire en l'ajoutant à un site de documentation. Vous pouvez ajouter autant d'espaces que vous le souhaitez à un site de documentation. Ainsi, lorsque vous développez votre contenu, vous pouvez créer des espaces séparés pour la documentation produit, la référence API, le journal des modifications, le centre d'aide et tout autre élément que vous souhaitez inclure dans votre documentation — et les publier tous sur un même site de documentation.
Vous pouvez également vouloir créer des versions traduites de votre documentation principale, ou des documents séparés pour différentes versions de votre produit. Chacun de ces éléments aura aussi son propre espace et pourra être ajouté à votre site de documentation unique pour que les utilisateurs puissent le parcourir.
Collection
Les collections fonctionnent comme des dossiers au sein de l'application GitBook, vous permettant de regrouper des espaces pour faciliter l'organisation et le stockage de votre contenu.
En plus de vous permettre de garder le contenu organisé, les collections facilitent également la gestion des autorisations au niveau du contenu à grande échelle. Vous pouvez remplacer les autorisations au niveau de l'organisation sur plusieurs espaces en les ajoutant à une collection et en définissant les autorisations pour l'ensemble de la collection.
Site de documentation
Vous pouvez publier votre contenu sous la forme d'un site de documentation. Votre documentation sera publiée et disponible pour le public sélectionné sous forme de site web que vous pouvez personnaliser avec votre propre branding, vos outils d'analyse et un domaine personnalisé.
Vous pouvez créer autant de sites de documentation que vous le souhaitez. Ils sont tous listés dans la barre latérale et dans la section Sites de documentation de l'application, où vous pouvez modifier les paramètres et les options de personnalisation. Vous pouvez contrôler tous les paramètres et options de votre site de documentation dans l'application GitBook.
Le contenu de votre site provient des espaces de votre organisation GitBook. Lorsque vous créez un nouveau site de documentation, vous pouvez créer un nouvel espace ou lier un espace existant. Un site de documentation peut contenir un espace ou plusieurs espaces contenant des contenus différents — y compris des traductions et des versions précédentes du produit.
Édition de contenu
L'éditeur visuel de GitBook vous permet d'utiliser une interface WYSIWYG (ce que vous voyez est ce que vous obtenez) pour ajouter du contenu à un espace.
Pages
Une page est l'endroit où vous ajoutez, modifiez et intégrez du contenu. Les pages résident toujours à l'intérieur d'un espace, et vous pouvez ajouter autant de pages à un espace que vous le souhaitez.
Les pages de votre espace apparaissent dans la table des matières à gauche de l'éditeur. Là, vous pouvez ajouter de nouvelles pages, créer des groupes de pages et imbriquer des pages les unes dans les autres pour créer des sous-pages.
Vous ne voyez pas comment modifier ou ajouter une page ?
Si votre site est publié, vous devrez créer une demande de modification avant de pouvoir apporter des changements au contenu d'un espace. Lisez à propos des demandes de modification ci-dessous.
Blocs
GitBook est un éditeur basé sur des blocs. Cela signifie que vous pouvez ajouter différents types de blocs à votre page — du texte standard et des images à des blocs plus avancés et interactifs. Vos pages peuvent inclure n'importe quelle combinaison de blocs, et il n'y a pas de limite au nombre de blocs que vous pouvez avoir sur une page.
L'édition par blocs facilite la réorganisation de votre contenu par glisser-déposer, ou l'ajout de nouveaux blocs au milieu d'un contenu existant. Vous pouvez créer de nouveaux blocs via l'interface de l'éditeur, ou créer et formater des blocs en utilisant Markdown.
Découvrez tous les blocs que vous pouvez utiliser dans GitBook dans la section Blocs.
Édition Markdown
L'éditeur de GitBook vous permet de créer et de formater des blocs de contenu en utilisant Markdown.
Markdown est une syntaxe de balisage populaire, largement connue pour sa simplicité. GitBook la prend en charge comme une méthode conviviale au clavier pour écrire du texte riche et structuré — tous les blocs de GitBook peuvent être rédigés en utilisant la syntaxe Markdown.
Synchronisation Git
Git Sync permet aux équipes de synchroniser des dépôts GitHub ou GitLab avec GitBook et de transformer des fichiers Markdown en une documentation attrayante et conviviale. Une fois configuré, il garde tout votre contenu synchronisé entre l'application GitBook et votre base de code.
Git Sync est bidirectionnel, donc les modifications que vous apportez dans l'éditeur visuel de GitBook sont automatiquement synchronisées — tout comme les commits effectués sur GitHub ou GitLab. Cela permet aux développeurs de commit directement depuis GitHub ou GitLab pendant que d'autres membres de l'équipe modifient et laissent des commentaires sur les modifications directement dans GitBook.
Git Sync débloque également de nombreux autres flux de travail utiles dans vos documents GitBook, tels que les modifications par lot, le linting, et plus encore. En savoir plus dans notre section Git Sync.
Le flux d'édition
Demandes de modification
Une demande de modification est une branche de votre contenu principal que vous pouvez utiliser pour effectuer des modifications concurrentes, tout en conservant l'historique des versions. Cela sera familier à quiconque utilise des pull requests sur GitHub ou des merge requests sur GitLab.
Si vous souhaitez modifier le contenu de votre site de documentation publié, vous devrez d'abord ouvrir une demande de modification dans votre espace.
Dans une demande de modification, vous pouvez ajouter, modifier et supprimer du contenu dans un espace, puis demander une révision à votre équipe et fusionner vos modifications dans votre contenu principal pour mettre à jour votre site de documentation publié.
Branchement en bref
L'ouverture d'une demande de modification crée une copie de votre contenu à ce moment précis, parfois appelée « branche ». Toutes les modifications que vous apportez n'apparaîtront pas dans votre contenu principal tant que vous n'aurez pas choisi de fusionner votre demande de modification.
L'avantage du branchement est que vos coéquipiers peuvent créer, modifier et fusionner leurs propres demandes de modification en même temps que vous sans se marcher sur les pieds. Et si quelqu'un modifie le même contenu que vous, GitBook vous guidera pour résoudre les conflits avant la fusion.
Révisions
Les révisions encouragent la supervision et aident à améliorer la qualité et l'exactitude de votre documentation.
Vous pouvez demander une révision de votre demande de modification avant de fusionner et de rendre les changements visibles sur votre site de documentation. Ajouter un titre et une description à votre demande de modification donne du contexte à vos réviseurs.
Les réviseurs peuvent voir le diff de votre demande de modification, qui met en évidence tout ce qui est nouveau, modifié ou supprimé dans votre demande. Ils peuvent également laisser des commentaires directement sur la page à l'aide de la fonctionnalité de commentaires intégrée — puis approuver votre demande de modification ou demander que d'autres modifications soient apportées.
Fusion
La fusion d'une demande de modification ajoutera tout le contenu de votre demande dans la branche principale du contenu — et ces modifications seront également mises en ligne sur votre site de documentation.
Lorsque vous fusionnez votre demande de modification, cela crée également une nouvelle version dans l'historique des versions de l'espace.
Publication de la documentation
Lorsque vous publiez votre contenu en tant que site de documentation, vous pouvez ajouter plus de contenu à votre site, modifier l'audience et personnaliser son apparence, son ambiance et d'autres paramètres.
Structurer votre site de documentation
Si vous souhaitez ajouter du contenu supplémentaire à votre site, deux options s'offrent à vous, chacune conçue pour des cas d'utilisation différents : les sections du site et les variantes.
Section du site
Les sections du site sont conçues pour vous permettre d'ajouter plusieurs types différents de documentation à un seul site de documentation. Par exemple, vous pourriez utiliser un seul site de documentation pour héberger la documentation produit, la référence API, le centre d'aide et le journal des modifications — comme nous le faisons sur ce site de documentation.
Lorsque vous ajoutez de nouvelles sections de site, vous développez la barre de navigation en haut de votre site, chaque section obtenant sa propre entrée dans la barre. Vous pouvez également regrouper des sections de site pour créer un menu déroulant dans votre barre de navigation — idéal pour ajouter de la hiérarchie à vos sections de site.
Variante
Les variantes sont conçues pour vous permettre d'ajouter plusieurs versions d'une même documentation à un seul site de documentation. Par exemple, vous pourriez vouloir localiser l'intégralité de votre documentation dans plusieurs langues, ou documenter les versions précédentes de votre produit pour les utilisateurs qui n'ont pas mis à jour.
Vos utilisateurs finaux peuvent basculer entre ces variantes sur votre site de documentation en utilisant le sélecteur de langue ou le sélecteur de variante en haut de la table des matières à gauche de votre site.
Audience du site
Vous pouvez choisir qui verra votre documentation lorsque vous la publiez. Par défaut, les nouveaux sites sont publiés publiquement et indexés par les moteurs de recherche.
Cependant, si vous souhaitez un contrôle plus fin sur qui peut accéder à votre site, vous pouvez choisir de limiter l'audience en utilisant liens de partage ou accès authentifié.
Avec les liens de partage, vous pouvez partager votre contenu de manière privée avec des clients ou des partenaires sans avoir à les inviter dans votre organisation en créant un lien privé et en le partageant directement avec eux. Toute personne disposant du lien peut accéder à votre site.
Si vous souhaitez encore plus de contrôle, l'accès authentifié vous permet de publier votre contenu tout en exigeant une authentification de la part des visiteurs qui veulent le consulter. Lorsqu'il est activé, GitBook laisse votre fournisseur d'authentification gérer qui a accès au contenu. C'est idéal pour du contenu privé ou pour publier une base de connaissances interne qui ne devrait être accessible qu'aux membres de votre équipe.
Vous pouvez également contrôler qui voit des pages ou des blocs individuels à l'aide d'une fonctionnalité appelée contenu adaptatif. Une fois configurée, elle affichera ou masquera le contenu en fonction des attributs utilisateur que vous définissez. En savoir plus dans les pages Contenu adaptatif.
Personnalisation du site
GitBook inclut des options de personnalisation intégrées pour les sites de documentation, vous aidant à faire correspondre l'apparence et la sensation de votre documentation à votre produit ou marque.
Même si vous n'appliquez aucune personnalisation, votre documentation aura fière allure telle quelle. Mais vous avez la possibilité de personnaliser les logos, icônes et couleurs, d'ajouter des polices personnalisées, ou de choisir parmi des thèmes intégrés qui aideront votre documentation à être aussi attrayante que votre produit.
Optimisations SEO et IA
La documentation publiée dans GitBook est automatiquement optimisée pour la recherche (SEO) et pour les systèmes d'IA comme ChatGPT, Claude et Google AI Overview (GEO). Ces optimisations sont gérées en arrière-plan, donc tout ce que vous avez à faire est d'écrire du contenu qui inclut les mots-clés et termes que vous souhaitez cibler.
Les pages récupèrent les métadonnées à partir du titre et de la description de chaque page, et votre contenu est formaté pour être responsive. GitBook crée automatiquement un sitemap basé sur votre table des matières, et les pages sont mises en cache et servies via notre CDN global pour améliorer les performances. Tout cela aide votre documentation à obtenir un bon classement dans les moteurs de recherche.
De même, GitBook optimise également pour les outils d'IA en suivant toutes les normes de l'industrie au fur et à mesure de leur évolution rapide.
GitBook crée automatiquement des versions .md de chaque page, ce qui facilite l'analyse par les grands modèles de langage (LLM). Nous exposons également automatiquement un serveur Model Context Protocol (MCP) pour chaque site publié, offrant aux outils d'IA un moyen structuré de découvrir et de récupérer vos docs en tant que ressources — sans nécessiter de scraping. De plus, votre site génère également llms.txt et llms-full.txt conçus pour l'ingestion par l'IA.
Gestion de l'équipe
Organisation
Une organisation GitBook contient tout le contenu et les sites de documentation d'une entreprise. Avec un seul compte, vous pouvez être membre d'une ou plusieurs organisations et basculer entre elles à l'aide du menu déroulant en haut à gauche de l'application GitBook.
Membres
Les membres sont les utilisateurs individuels au sein de votre organisation. Vous pouvez avoir autant de membres que vous le souhaitez dans une organisation, chacun avec des autorisations adaptées à leurs besoins d'accès spécifiques.
Autorisations
Les autorisations vous permettent de décider du niveau d'accès des membres de votre organisation. Lorsqu'un membre rejoint votre organisation, vous lui attribuez un rôle — tel qu'Éditeur ou Lecteur. Ces rôles définissent leurs autorisations pour l'ensemble du contenu de votre organisation. Mais vous pouvez également remplacer ces autorisations au niveau du contenu. Par exemple :
Vous pouvez donner à une personne ayant le rôle Lecteur un accès d'édition à un contenu particulier
Vous pouvez limiter l'accès à un contenu confidentiel ou privé spécifique et n'accorder l'accès qu'à certains membres de votre organisation.
En savoir plus sur la page Autorisations et héritage.
Mis à jour
Ce contenu vous a-t-il été utile ?