Démarrage rapide
Démarrez rapidement 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 disposerez d’un site de documentation en ligne, prêt à être enrichi et personnalisé.
Pour commencer
Vous devrez créer un compte avant de pouvoir commencer à créer votre premier site de documentation.
Après avoir créé votre compte, vous verrez automatiquement apparaître 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.
Votre contenu n’est pas encore publié — vous pouvez donc modifier, personnaliser et prévisualiser votre site de documentation avant sa mise en ligne. Cliquez sur Publier pour le mettre en ligne immédiatement.
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 flux de travail docs-as-code. Vous pouvez choisir l’une ou l’autre, ou utiliser une combinaison des deux.
Quel que soit le flux de travail que vous préférez, vous modifierez votre contenu à l’aide d’un flux de modification basé sur les branches. En savoir plus sur la page Concepts.
Utiliser l’éditeur visuel
L’éditeur de type WYSIWYG (« ce que vous voyez est ce que vous obtenez ») 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 flux de travail de modification visuelle est idéal pour les utilisateurs qui ne souhaitent 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 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 dans laquelle vous pouvez éditer 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.
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 passer d’une vue à l’autre 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 sur mobile.
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 issues de la demande de modification. Si le contenu fait partie d’un site de documentation en ligne, le site sera mis à jour immédiatement.
Modification basée sur le code
Synchronisez votre documentation avec un dépôt GitHub ou GitLab pour activer la modification basée sur le code. Une fois la synchronisation effectuée, 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’outil et préfèrent gérer leur documentation en parallèle de 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 la page Pages Git Sync pour en savoir plus.
2. Modifiez vos docs depuis votre environnement de développement
Une fois votre espace synchronisé 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 Markdownles fichiers Markdown
Chaque bloc standard dans GitBook peut être rédigé et formaté à l’aide de la syntaxe Markdown.
3. Prévisualisez vos modifications
Vous pouvez prévisualisez 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 l’apparence de votre site une fois la pull request fusionnée et votre site 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 sous forme de mises à jour dans l’historique des versions.
Personnalisez vos docs
Organisez la navigation de votre site
Vous pouvez ajouter à tout moment d’autres contenus à votre site — comme une référence API, un centre d’aide ou un journal des modifications. Lorsque vous ajoutez du contenu, vous pouvez organiser la barre de navigation de votre site pour aider les utilisateurs à trouver facilement ce qu’ils recherchent.
Accédez à la page Concepts pour en savoir plus sur la navigation du site.
Accédez à la page Structure du site pour en savoir plus sur l’ajout de contenu à votre site.
Personnalisez l’apparence et le ressenti de votre site de documentation
Votre site de documentation sera superbe dès le départ, mais vous pouvez également personnaliser de nombreux paramètres qui modifient l’apparence et le ressenti de votre site publié.
Vous pouvez personnaliser le logo, les couleurs et la policede votre site, ajouter à la barre de navigation de votre site à l’aide de sections du site et les variantesmettre à jour les paramètres de visibilité de votre site et bien plus encore.
Publiez votre documentation
Publier vos docs
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 en haut à droite 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.
Vous souhaitez en savoir plus sur la publication ? Consultez notre guide complet pour créer et publier du contenu dans GitBook.
Ajouter un domaine personnalisé
Par défaut, votre site sera publié avec une URL unique au format suivant :
https://[nom-de-l-organisation].gitbook.io/[titre-du-site]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.
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.
La prise en compte de vos modifications DNS peut prendre jusqu’à 48 heures — bien qu’elles se propagent généralement beaucoup plus vite.
Étapes suivantes
Invitez votre équipe à collaborer
Ajoutez des membres à votre organisation et définissez les autorisations
Modifier la visibilité du site
Contrôlez qui peut voir votre contenu grâce aux liens de partage et à l’accès authentifié
Installer des intégrations
Intégrez votre pile et étendez les fonctionnalités grâce à des intégrations puissantes
FAQ
Qu’est-ce que GitBook ?
GitBook est une plateforme de documentation collaborative, native de l’IA, où les équipes peuvent créer, relire et publier des docs 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é utilisant 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 façon dont votre équipe choisit d’utiliser GitBook, vous utiliserez un flux de travail de branchement de type Git avec un historique complet des versions, qui protège votre contenu principal tout en favorisant la collaboration et les retours dans toute votre équipe.
GitBook est-il open source ?
GitBook n’est pas open source. En revanche, la plateforme de documentation publiée de GitBook — qui sert à héberger et afficher la documentation sur un site de documentation — est open source. Vous pouvez visiter le dépôt pour voir le code et soumettre des modifications pour examen.
Bien que GitBook ne soit pas 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 en utilisant un plan de site sponsorisé, tous deux 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 portail de documentation global, hébergeant tout le contenu accessible à votre audience et offrant 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 مرتبط 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 sur un seul site pour créer une structure ou activer des options comme les traductions (pour une documentation localisée) ou la prise en charge de plusieurs produits.
Quelles sont les différences entre l’éditeur visuel de GitBook et Git Sync ?
GitBook propose deux méthodes principales pour modifier 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 à manipuler directement du code.
Synchronisation Git intègre votre flux de travail de documentation à 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 en parallèle de leur base de code, en utilisant des commandes et des flux de travail 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 qu’elle préfère, la modification suit un flux de travail 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 l’ensemble de vos docs — cela protège aussi le contenu principal contre les modifications accidentelles.
Mis à jour
Ce contenu vous a-t-il été utile ?
Comment publier de 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 paramètre public ou limiter l’audience avec des liens de partage ou l’accès authentifié.
(Facultatif) Personnalisez l’identité visuelle, le domaine et le thème à l’aide des options intégrées.
Cliquez sur 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.