Démarrage rapide

Démarrez avec GitBook 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é.

Commencer

Vous devrez créer un compte 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 publier à partir des options affichées à l'écran.

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 rendre disponible immédiatement.

Accédez à la section « Publication » de cette page

Modifiez votre contenu

Il existe deux façons d'éditer et de mettre à jour votre contenu dans GitBook — dans notre éditeur visuel, ou en suivant un flux de travail docs-as-code. Vous pouvez en choisir une, ou utiliser une combinaison des deux.

Quel que soit le flux de travail que vous préférez, vous modifierez votre contenu en utilisant un flux d'édition basé sur des branches. En savoir plus sur la page Concepts.

Utilisez l'éditeur visuel

L'éditeur WYSIWYG (ce que vous voyez est ce que vous obtenez) de GitBook vous permet d'éditer le contenu visuellement, de déplacer des blocs de contenu pour les réorganiser et de voir à quoi ressemblera votre contenu au fur et à mesure.

Ce flux d'édition visuel est idéal pour les utilisateurs qui ne veulent pas travailler dans un éditeur de code, ou qui ont de l'expérience avec des outils comme Notion ou Google Docs.

1. Modifiez vos docs dans une requête de changement

Tout d'abord, trouvez votre site de documentation dans la barre latérale et cliquez sur l'élément en dessous. Cela vous amène à l'espace où votre contenu se trouve.

Cliquez Modifier en haut à droite. Cela ouvre une requête de changement où vous pouvez modifier le contenu de l'espace.

Cliquez Ajouter… dans la table des matières à gauche pour ajouter une page, et 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. Ceux-ci permettent de basculer entre différentes vues de votre contenu.

Cliquez Aperçu pour voir un aperçu en direct de l'apparence de votre site de documentation avec toutes les modifications de votre requête de changement, 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 que vous êtes satisfait de vos modifications, cliquez sur le Fusionner bouton en haut à droite.

Cela mettra à jour la version principale de votre contenu avec toutes les modifications de la requête de changement. Si le contenu fait partie d'un site de documentation en ligne, le site sera mis à jour immédiatement.

Édition basée sur le code

Synchronisez votre documentation avec un dépôt GitHub ou GitLab pour permettre l'édition basée sur le code. Une fois synchronisé, vous pouvez modifier vos docs dans votre environnement de développement existant.

Ce flux de travail est idéal pour les utilisateurs techniques qui ne veulent pas changer d'outils et préfèrent gérer leur documentation aux côtés du code.

1. Configurez Git Sync

Si vous n'avez pas déjà configuré Git Sync lors de la création de votre site, trouvez d'abord votre site de documentation dans la barre latérale et cliquez sur le nom du contenu en dessous. Cela vous amène à l'espace où votre contenu se trouve.

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

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

2. Modifiez vos docs depuis votre environnement de développement

Une fois que vous avez synchronisé votre espace avec votre dépôt Git, vous pouvez mettre à jour le contenu de vos docs 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.

Édition Markdown

GitBook prend en charge Édition Markdown, vous pouvez donc créer et formater du contenu en utilisant une syntaxe courante.

Chaque bloc standard dans GitBook peut être écrit et formaté en utilisant la syntaxe Markdown.

3. Prévisualisez vos modifications

Vous pouvez prévisualiser vos modifications sur votre site de documentation publié depuis la pull request sur 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 comment votre site apparaîtra lorsque la pull request sera fusionnée et que votre site sera mis à jour.

4. Fusionnez vos modifications

Vous êtes prêt. 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 en tant que 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.

Personnalisez vos docs

Organisez la navigation de votre site

Vous pouvez ajouter davantage de contenu à votre site — comme 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 plus facilement ce qu'ils recherchent.

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

Personnalisez l'apparence de votre site de documentation

Votre site de documentation aura une belle apparence dès le départ, mais vous pouvez également personnaliser de nombreux paramètres qui modifient l'apparence et l'ambiance de votre site publié.

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

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

Publiez votre documentation

Publiez vos docs

Vous pouvez publier votre site d'un simple 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 Publier en haut à droite pour le mettre en ligne.

Une fois votre site en ligne, le tableau de bord se mettra à jour avec un lien vers le site en direct.

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.

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

Ajoutez un domaine personnalisé

Par défaut, votre site sera publié avec une URL unique au format suivant :

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

Bien que cela puisse convenir à certaines équipes, beaucoup choisissent de modifier leur URL pour 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, et suivez les instructions pour configurer les paramètres DNS auprès de votre fournisseur de domaine.

Il peut falloir jusqu'à 48 heures pour que vos modifications DNS prennent effet — bien qu'elles se propagent généralement beaucoup plus rapidement.

Étapes suivantes

Inviter votre équipe à collaborer

Ajoutez des membres d'équipe à votre organisation et définissez des autorisations

Modifier la visibilité du site

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

Ajouter des traductions automatiques

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

Installer des intégrations

Intégrez-vous à votre stack et étendez les fonctionnalités avec des intégrations puissantes

Ajouter une référence d'API

Créez des documents de référence API interactifs et mis à jour automatiquement à partir d'une spécification API

Suivre les analyses de la documentation

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

FAQ

Qu'est-ce que GitBook ?

GitBook est une plateforme de documentation collaborative, native IA, où les équipes peuvent créer, relire et publier des documents 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 IA via MCP.

Vous pouvez modifier le contenu en utilisant l'éditeur visuel avancé avec Markdown, synchroniser vos docs avec un dépôt Git pour un flux de travail 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 flux d'édition ressemblant à Git avec un historique complet des versions, qui protège votre contenu principal tout en favorisant la collaboration et les retours au sein de toute votre équipe.

Comment publiez-vous la documentation avec GitBook ?

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

Créez un nouveau site de documentation (ou ouvrez-en un existant) et choisissez le contenu que vous souhaitez publier.
Choisissez l'audience de votre site. Vous pouvez publier pour tout le monde avec le réglage public ou limiter l'audience avec liens de partage ou accès authentifié.
(Optionnel) Personnalisez l'image de marque, le domaine et le thème en utilisant les options intégrées.
Cliquez Publier. Félicitations — vos docs sont en ligne ! Vous pouvez ajouter d'autres espaces plus tard en tant que sections du site ou 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.

GitBook est-il open source ?

GitBook lui-même n'est pas open source. Cependant, la plateforme de documentation publiée de GitBook — utilisée pour héberger et afficher la documentation sur un site — est open source. Vous pouvez visiter le dépôt pour voir le code et soumettre des modifications pour examen.

Bien que GitBook lui-même ne soit pas open source, les projets open source peuvent publier leur documentation sur GitBook gratuitement. Les équipes peuvent s'inscrire au plan Communauté et publier du contenu en utilisant un plan de site sponsorisé, dont les deux sont gratuits pour les équipes éligibles.

Quelle est la différence entre un site et un espace dans GitBook ?

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

Chaque site contient une ou plusieurs espaces, qui servent de sections individuelles au sein du site, organisant le contenu lié pour une meilleure modularité et une plus grande facilité de gestion. Les espaces vous permettent de concentrer la collaboration sur des sujets spécifiques, et vous pouvez combiner plusieurs espaces sur un seul site pour construire la structure ou activer des options comme les traductions (pour la documentation localisée) ou la prise en charge multi-produit.

Quelles sont les différences entre l'éditeur visuel de GitBook et Git Sync ?

GitBook propose deux méthodes principales pour éditer 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 modifier du contenu directement dans GitBook en utilisant une interface utilisateur traditionnelle qui inclut la prise en charge du Markdown. Il est idéal pour ceux qui préfèrent une expérience d'édition plus intuitive et pratique sans manipuler directement du code.

Synchronisation Git intègre votre flux de travail de documentation avec un dépôt Git, 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 aux côtés de leur base de code, en utilisant des commandes et des flux Git familiers.

Votre équipe peut choisir l'un de ces flux de travail, ou utiliser une combinaison des deux. Et quelle que soit la méthode préférée, l'édition suit un flux de travail cohérent de type Git avec un historique complet des versions et un processus de revue de contenu. Cela ne favorise pas seulement la collaboration et la qualité de vos docs — cela protège aussi le contenu principal contre les modifications accidentelles.

Mis à jour il y a 22 jours

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