circle-info
New: AI Insights are here.
See what your users are asking.arrow-up-right
search
PricingLog inSign up

boltDémarrage rapide

Prenez GitBook en main et publiez votre premier site de documentation en quelques minutes

Ce guide de démarrage rapide explique comment configurer GitBook et publier votre premier site de documentation en quelques minutes.

À la fin de ce guide, vous aurez un site de documentation en ligne, prêt à être développé et personnalisé.

1

Pour commencer

Vous devrez créer un comptearrow-up-right avant de pouvoir commencer avec votre premier site de documentation.

Après avoir créé votre compte, vous verrez automatiquement un nouveau site de documentation prêt à être modifié et personnalisé. Choisissez comment vous souhaitez ajouter du contenu à votre site avant de le publier, à partir des options à l’écran.

circle-check

Votre contenu n’est pas encore publié — vous pouvez donc modifier, personnaliser et prévisualiser votre site de documentation avant de le mettre en ligne. Cliquez sur Publier pour le mettre en ligne immédiatement.

arrow-down Accédez à la section « Publication » sur cette page

2

Modifiez votre contenu

Il existe deux façons de modifier et de mettre à jour votre contenu dans GitBook — dans notre éditeur visuel, ou en suivant un workflow docs-as-code. Vous pouvez choisir l’une ou l’autre, ou utiliser une combinaison des deux.

Quel que soit le workflow que vous préfériez, vous modifierez votre contenu à l’aide d’un flux de modification basé sur les branches. En savoir plus sur la page Concepts.

chevron-rightUtiliser l’éditeur visuelhashtag

L’éditeur WYSIWYG (« what you see is what you get ») de GitBook vous permet de modifier le contenu visuellement, de faire glisser des blocs de contenu pour les réorganiser et de voir à quoi ressemblera votre contenu au fur et à mesure de votre travail.

Ce workflow de modification visuelle est idéal pour les utilisateurs qui ne veulent pas travailler dans un éditeur de code, ou qui ont l’expérience d’outils comme Notion ou Google Docs.

1. Modifiez votre documentation dans une demande de modification

Commencez par trouver votre site de documentation dans la barre latérale et cliquez sur l’élément situé en dessous. Cela vous mène à l’espace où se trouve votre contenu.

Cliquez sur Modifier en haut à droite. Cela ouvre une demande de modification où vous pouvez modifier le contenu de l’espace.

Cliquez sur Ajouter un nouveau… dans la table des matières à gauche pour ajouter une page, puis donnez-lui un titre.

A screenshot of the Editor in the GitBook app, zoomed in to show the menu that lets you add new pages, groups, links and more to a GitBook space.

2. Prévisualisez vos modifications

En haut de l’application web, vous verrez des onglets pour Éditeur, Modifications et Aperçu. Ils permettent de basculer entre différentes vues de votre contenu.

Cliquez sur Aperçu pour voir un aperçu en direct de l’apparence de votre site de documentation avec toutes les modifications de votre demande de modification, sur ordinateur et mobile.

A screenshot of the GitBook app with the Preview tab open, showing a docs site being previewed on a mobile-size display

3. Fusionnez vos modifications

Une fois satisfait de vos modifications, cliquez sur le bouton Fusionner en haut à droite.

Cela mettra à jour la version principale de votre contenu avec toutes les modifications de la demande de modification. Si le contenu fait partie d’un site de documentation en ligne, le site sera mis à jour immédiatement.

chevron-rightModification basée sur le codehashtag

Synchronisez votre documentation avec un dépôt GitHub ou GitLab pour activer la modification basée sur le code. Une fois synchronisée, vous pouvez modifier votre documentation dans votre environnement de développement habituel.

Ce workflow est idéal pour les utilisateurs techniques qui ne veulent pas changer d’outil et préfèrent gérer leur documentation en même temps que leur autre code.

1. Configurez Git Sync

Si vous n’avez pas encore configuré Git Sync lors de la création de votre site, commencez par trouver votre site de documentation dans la barre latérale et cliquez sur le nom du contenu situé en dessous. Cela vous mène à l’espace où se trouve votre contenu.

Cliquez sur le Configurer Git Sync bouton en haut à droite et suivez les instructions pour synchroniser votre espace avec le dépôt Git de votre choix.

Rendez-vous sur les pages Git Sync pour en savoir plus.

2. Modifiez votre documentation depuis votre environnement de développement

Une fois votre espace synchronisé avec votre dépôt Git, vous pouvez mettre à jour le contenu de votre documentation depuis ce dépôt dans votre environnement de développement.

Ouvrez le dépôt, créez une pull request et apportez les modifications souhaitées.

circle-info

hashtag
Modification Markdown

GitBook prend en charge Modification Markdown, ce qui vous permet de créer et de mettre en forme du contenu à l’aide d’une syntaxe courante.

Chaque bloc standard dans GitBook peut être rédigé et mis en forme à l’aide de la syntaxe Markdown.

3. Prévisualisez vos modifications

Vous pouvez prévisualiser vos modifications sur votre site de documentation publié à partir de la pull request dans GitHub ou GitLab.

Dans votre pull request, vous verrez un statut avec une URL d’aperçu unique. Cliquez sur Détails sur ce statut pour ouvrir l’URL d’aperçu et voir à quoi ressemblera votre site lorsque la pull request sera fusionnée et que votre site sera mis à jour.

4. Fusionnez vos modifications

Et voilà. Fusionnez votre pull request et votre contenu sera mis à jour à la fois dans l’application GitBook et sur votre site de documentation, s’il est en ligne.

Dans l’application GitBook, chaque commit et votre pull request fusionnée seront synchronisés avec votre espace sous forme de mises à jour dans l’historique des versions.

A screenshot of the GitBook app showing the version history side panel open. In the side panel the highlighted entry shows a pull request from GitHub that was merged as part of the history, with a link to view the pull request on GitHub.
3

Personnalisez votre documentation

chevron-rightOrganisez la navigation de votre sitehashtag

Vous pouvez ajouter davantage de contenu à votre site — par exemple une référence d’API, un centre d’aide ou un journal des modifications — à tout moment. Lorsque vous ajoutez du contenu, vous pouvez organiser la barre de navigation de votre site pour aider les utilisateurs à trouver facilement ce qu’ils cherchent.

Rendez-vous sur la page Concepts pour en savoir plus sur la navigation du site.

Rendez-vous sur la page Structure du site pour en savoir plus sur l’ajout de contenu à votre site.

A screenshot of a published docs site hosted on GitBook. The top of the site has a navigation bar, and the cursor is hovering over a drop-down in that bar, with a submenu open below it showing links to more pages
chevron-rightPersonnalisez l’apparence et le style de votre site de documentationhashtag

Votre site de documentation sera superbe dès le départ, mais vous pouvez aussi personnaliser de nombreux réglages qui modifient l’apparence et le style de votre site publié.

Vous pouvez personnaliser le logo, les couleurs et la police, ajouter à la barre de navigation de votre site à l’aide de sections du site et variantes, mettre à jour la visibilité du site paramètres et bien plus encore.

An illustration showing five docs sites hosted in GitBook, each with distinct visual customizations
4

Publiez votre documentation

chevron-rightPublier votre documentationhashtag

Vous pouvez publier votre site en un clic à tout moment.

Ouvrez le tableau de bord de votre site en cliquant sur le nom du site dans la barre latérale. Puis cliquez sur Publier dans le coin supérieur droit pour le mettre en ligne.

Une fois votre site en ligne, le tableau de bord sera mis à jour avec un lien vers le site en ligne.

A screenshot of the GitBook app showing a dashboard for a docs site. The dashboard shows the public URL, site status, site content, some top-level analytics for the site, and other options in tabs along the top of the screen.
circle-check

Vous voulez explorer la publication plus en détail ? Consultez notre guide complet pour créer et publier du contenu dans GitBook.

chevron-rightAjouter un domaine personnaliséhashtag

Par défaut, votre site sera publié avec une URL unique de ce format :

https://[organization-name].gitbook.io/[site-title]

Bien que cela puisse convenir à certaines équipes, beaucoup choisissent de changer leur URL en un domaine personnalisé ou un sous-répertoire personnalisé.

Pour ce faire, ouvrez le tableau de bord de votre site en cliquant sur le nom du site dans la barre latérale, puis ouvrez l’onglet Paramètres et choisissez Domaine et URL.

A screenshot of the GitBook app showing the menu that guides you through the process of setting up a custom domain for your docs site.

Utilisez les boutons à l’écran pour choisir l’option souhaitée, puis suivez les instructions pour configurer les paramètres DNS avec votre fournisseur de domaine.

circle-info

Les modifications DNS peuvent prendre jusqu’à 48 heures pour prendre effet — même si elles se propagent généralement beaucoup plus rapidement.

hashtag
Étapes suivantes

Cover

Invitez votre équipe à collaborer

Ajoutez des membres à votre organisation et définissez les autorisations

Cover

Modifier la visibilité du site

Contrôlez qui peut voir votre contenu avec des liens de partage et l’accès authentifié

Cover

Ajouter des auto-traductions

Créez des traductions en un clic qui se mettent à jour automatiquement

Cover

Installer des intégrations

Intégrez-les à votre pile et étendez les fonctionnalités grâce à de puissantes intégrations

Cover

Ajouter une référence d’API

Créez une documentation de référence d’API interactive, mise à jour automatiquement, à partir d’une spécification d’API

Cover

Suivre les statistiques de la documentation

Utilisez les analyses intégrées pour mesurer le succès et comprendre le comportement des utilisateurs

hashtag
FAQ

chevron-rightQu’est-ce que GitBook ?hashtag

GitBook est une plateforme de documentation collaborative, native à l’IA, où les équipes peuvent créer, relire et publier une documentation de marque sous forme de sites web. Les sites de documentation hébergés sur GitBook peuvent proposer un Assistant IA intégré et se connecter à d’autres outils d’IA via MCP.

Vous pouvez modifier le contenu à l’aide de l’éditeur visuel avancé prenant en charge Markdown, synchroniser votre documentation avec un dépôt Git pour un workflow docs as code — ou utiliser une combinaison des deux. Quelle que soit la manière dont votre équipe choisit d’utiliser GitBook, vous utiliserez un workflow de branches de type Git avec un historique complet des versions, ce qui protège votre contenu principal tout en encourageant la collaboration et les retours au sein de toute votre équipe.

chevron-rightComment publier de la documentation avec GitBook ?hashtag

Publier dans GitBook est un processus simple une fois que votre contenu est prêt à être mis en ligne :

  1. Créez un nouveau site de documentation (ou ouvrez-en un existant) et choisissez le contenu que vous souhaitez publier.

  2. Choisissez votre audience pour le site. Vous pouvez publier pour tout le monde avec le paramètre public , ou limiter l’audience avec les liens de partage ou l’accès authentifié.

  3. (Facultatif) Personnalisez l’image de marque, le domaine et le thème à l’aide des options intégrées.

  4. Cliquez sur Publier. Félicitations — votre documentation est en ligne ! Vous pouvez ajouter plus d’espaces plus tard sous forme de sections du site ou de variantes.

Pour en savoir plus, consultez notre guide de démarrage rapide ci-dessus, ou lisez le guide complet pour créer et publier de la documentation dans GitBook.

chevron-rightGitBook est-il open source ?hashtag

GitBook n’est pas open source. En revanche, la plateforme de documentation publiée de GitBook — utilisée pour héberger et afficher la documentation sur un site de documentation — est open source. Vous pouvez visiter le dépôtarrow-up-right pour voir le code et soumettre des modifications pour examen.

Bien que GitBook ne soit pas lui-même open source, les projets open source peuvent publier gratuitement leur documentation sur GitBook. Les équipes peuvent s’inscrire au plan Community et publier du contenu à l’aide d’ un plan de site sponsorisé, tous deux gratuits pour les équipes éligibles.

chevron-rightQuelle est la différence entre un site et un espace dans GitBook ?hashtag

Dans GitBook, un site de documentation est votre centre de documentation global, hébergeant tout le contenu accessible à votre audience et proposant des options personnalisables comme le thème et le domaine.

Chaque site contient un ou plusieurs espaces, qui servent de sections individuelles au sein du site, organisant le contenu associé pour une meilleure modularité et une gestion plus simple. Les espaces vous permettent de concentrer votre collaboration sur des sujets spécifiques, et vous pouvez combiner plusieurs espaces dans un seul site pour structurer le contenu ou activer des options comme les traductions (pour une documentation localisée) ou la prise en charge de plusieurs produits.

chevron-rightQuelles sont les différences entre l’éditeur visuel de GitBook et Git Sync ?hashtag

GitBook propose deux principales méthodes de modification de la documentation — l’éditeur visuel et Git Sync. L’ éditeur visuel est un éditeur avancé basé sur des blocs qui vous permet de créer et de modifier du contenu directement dans GitBook à l’aide d’une interface utilisateur traditionnelle prenant en charge Markdown. Il est idéal pour ceux qui préfèrent une expérience de modification plus intuitive et pratique sans avoir à traiter directement du code.

Git Sync intègre votre workflow de documentation à un dépôt Git, en permettant une approche « docs as code ». Cette option est idéale pour les développeurs et les équipes qui préfèrent gérer la documentation en parallèle de leur base de code, en utilisant des commandes et des workflows Git familiers.

Votre équipe peut choisir l’un de ces workflows, ou utiliser une combinaison des deux. Et quelle que soit la méthode préférée, la modification suit un workflow de branches cohérent de type Git avec un historique complet des versions et un processus de relecture du contenu. Cela ne favorise pas seulement la collaboration et la qualité dans toute votre documentation — cela protège également le contenu principal contre les modifications accidentelles.

Mis à jour

Ce contenu vous a-t-il été utile ?