Démarrage rapide
Mettez GitBook en route 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 étendu et personnalisé.
Créez votre compte
Créer un compte pour commencer avec votre premier site de documentation.
Choisissez comment vous voulez commencer
GitBook vous souhaite la bienvenue sur votre nouveau site et vous demande comment vous souhaitez commencer.
Modèle de documentation
Commencer à partir d'une mise en page de documentation prête à l'emploi avec des sections de remplacement — le moyen le plus rapide de voir un site complet fonctionner.
Importer
Importer du contenu existant depuis des docs en ligne, du Markdown ou du HTML.
OpenAPI
Générer une documentation de référence d'API interactive à partir d'une spécification OpenAPI.
Vide
Commencer à partir d'une section vide et construire à partir de zéro.
Synchroniser avec Git
Garder votre documentation synchronisée avec un dépôt GitHub ou GitLab.
Ou bien, vous pouvez choisir parmi le contenu existant de votre organisation si vous avez déjà du contenu dans GitBook.
Ce guide suit le parcours du modèle :
Cliquez sur Modèle de documentation et examinez l'aperçu.
Cliquez sur Utiliser le modèle de documentation pour l'appliquer.
Explorez votre nouveau site
Votre site s'ouvre comme non publié, afin que vous puissiez tout modifier, personnaliser et prévisualiser avant sa mise en ligne. La barre latérale affiche :
En-tête du site
Le nom de votre site, son état de publication et les Aperçu et Publier boutons.
Général
Vue d’ensemble, Demandes de modification, Structure du site, et Paramètres.
Outils
Guide de style, Personnaliser, Analyser, et Étendre.
Contenu
Voici les sections de votre site - pour le modèle Docs : Accueil, Documentation, Référence API, Journal des modifications et Centre d'aide. Utilisez les icônes de Contenu l'en-tête pour trouver, renommer et ajouter des sections.
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 Publier pour le mettre en ligne immédiatement.
Modifiez votre contenu
Le modèle Docs vous propose des sections de remplacement dans la Contenu partie de la barre latérale. Cliquez sur n'importe quelle section pour l'ouvrir et voir son contenu de remplacement.
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 en choisir une, ou combiner les deux. Quel que soit le flux de travail 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.
L'éditeur WYSIWYG (what you see is what you get) de GitBook vous permet de modifier le contenu visuellement, de faire glisser les blocs de contenu pour les réorganiser et de voir à quoi ressemble votre contenu pendant que vous travaillez. Il est idéal si vous ne voulez pas travailler dans un éditeur de code ou si vous avez l'habitude d'outils comme Notion ou Google Docs.
Modifiez votre documentation dans une demande de modification
Dans l’ Contenu section de la barre latérale, cliquez sur une section — par exemple Documentation — pour l'ouvrir.
Cliquez sur Modifier dans le coin supérieur droit. Cela ouvre une demande de modification dans laquelle vous pouvez modifier le contenu de la section.
Cliquez sur Ajouter un nouveau… > Page dans la table des matières sur la gauche.
Donnez un titre à votre nouvelle page.
Prévisualisez vos modifications
En haut de l'application web, vous verrez des onglets pour Éditeur, onglet Modifications, et Aperçu. Ils permettent de passer d'une vue à l'autre de votre contenu. Cliquez Aperçu pour voir à quoi ressemble votre site de documentation avec toutes les modifications de votre demande de modification, sur ordinateur et mobile.
Fusionnez vos modifications
Une fois que vos modifications vous conviennent, cliquez sur le Fusionner bouton dans le coin supérieur droit. Cela met à 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 se met à jour immédiatement.
Synchronisez votre documentation avec un dépôt GitHub ou GitLab pour permettre la modification basée sur le code dans votre environnement de développement existant. C'est idéal pour les utilisateurs techniques qui préfèrent gérer la documentation avec le reste du code.
Configurer Git Sync
Ouvrez la section que vous souhaitez synchroniser depuis la Contenu partie de la barre latérale.
Cliquez sur l'indicateur Git Sync Configurer dans la barre supérieure.
Suivez les instructions pour synchroniser la section avec le dépôt Git de votre choix. Rendez-vous sur les pages Git Sync pour en savoir plus.
Modifiez votre documentation depuis votre environnement de développement
Une fois votre section synchronisée avec votre dépôt Git :
Ouvrez le dépôt.
Créez une pull request.
Apportez les modifications souhaitées.
GitBook prend en charge la modification en Markdown, afin que vous puissiez créer et formater du contenu à l'aide d'une syntaxe courante.
Chaque bloc standard de GitBook peut être rédigé et mis en forme à l'aide de Markdown.
Prévisualisez vos modifications
Vous pouvez prévisualiser vos modifications sur votre site de documentation publié depuis la pull request dans GitHub ou GitLab. Votre pull request affiche un statut avec une URL d'aperçu unique. Cliquez sur Détails sur ce statut pour l'ouvrir et voir à quoi votre site ressemblera une fois fusionné.
Fusionnez vos modifications
Fusionnez votre pull request et vos mises à jour de contenu à 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 se synchronisent avec votre section sous forme de mises à jour dans l'historique des versions.
Personnalisez votre documentation
Organisez la navigation de votre site
Ajoutez du contenu à votre site — une référence API, un centre d'aide, un journal des modifications — à tout moment, et organisez la barre de navigation de votre site pour que les visiteurs trouvent ce qu'ils cherchent. Rendez-vous sur Structure du site pour en savoir plus sur les sections, les groupes et les variantes.
Personnalisez l'apparence
Votre site est superbe dès le départ — et sous Personnaliser, vous pouvez définir votre propre logo, couleurs et police, ajuster la mise en page et mettre à jour la visibilité du site.
Publiez votre documentation
Vous pouvez publier votre site d'un simple clic à tout moment.
Ouvrez votre site depuis votre organisation Accueil.
Cliquez sur Publier dans l'en-tête du site.
Une fois votre site en ligne, l' Vue d’ensemble écran se met à jour avec un lien vers le site en ligne.
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 est 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é.
Développer Paramètres dans la barre latérale de votre site.
Cliquez sur Domaine et URL.
Choisissez l'option souhaitée.
Suivez les instructions pour configurer les paramètres DNS auprès de votre fournisseur de domaine.
Les changements DNS peuvent prendre jusqu'à 48 heures pour prendre effet — bien qu'ils se propagent généralement beaucoup plus rapidement.
Étapes suivantes
Installer des intégrations
Intégrez votre stack et étendez les fonctionnalités grâce à de puissantes intégrations
Ajouter une référence API
Créez une documentation de référence API interactive et mise à jour automatiquement à partir d'une spécification d'API
Mis à jour
Ce contenu vous a-t-il été utile ?