Démarrage rapide

Commencer

Vous aurez besoin d’un compte GitBook pour commencer à publier de la documentation.

Sign up

Créer un site de documentation

Lorsque vous vous inscrivez pour la première fois, vous aurez la possibilité de créer un site de documentation à partir de l’assistant de création de site. Vous pouvez relancer l’assistant à tout moment pour créer un nouveau site en cliquant sur le + bouton à côté de l’en-tête Sites de documentation dans la barre latérale.

L’assistant de création de site vous guidera dans le processus de création de votre premier site. Vous devrez donner un nom à votre site, choisir si vous souhaitez commencer à partir de zéro avec un site vide ou ajouter notre contenu d’exemple, et décider si vous souhaitez publier votre documentation immédiatement ou non.

Modifiez votre contenu

Maintenant que vous avez créé un site, vous pouvez modifier ou importer votre contenu. Si vous avez un dépôt existant sur GitHub ou GitLab avec votre documentation, vous pouvez facilement migrer et synchroniser votre contenu vers GitBook en utilisant Git Sync. Pour en savoir plus, consultez notre guide de migration de contenu avec Git Sync.

Après avoir importé votre contenu, vous pouvez modifier vos pages à l’aide de l’éditeur intégré de GitBook et faire des choses comme ajouter des blocs interactifs, personnaliser la mise en page de vos pages et bien plus encore.

Consultez ces ressources si vous souhaitez en savoir plus sur l’expérience d’édition dans GitBook :

Démarrer une demande de modification

Collaborez sur le contenu avec votre équipe.

Installer une intégration

Intégrez vos outils préférés à votre site publié.

Ajouter une spécification OpenAPI

Ajoutez des méthodes d’API directement dans votre documentation.

Personnalisez votre site

Non seulement vous pouvez modifier le contenu de votre site, mais vous pouvez également personnaliser de nombreux paramètres liés à l’apparence et au ressenti de votre site une fois publié.

Vous pouvez modifier des éléments comme le logo, les couleurs et les polices, ajouter plus de structure grâce aux sections du site et aux variantes, ou mettre à jour les paramètres de visibilité du site.

Vous pouvez en savoir plus sur la personnalisation de votre documentation dans les ressources ci-dessous :

Personnalisez votre site

Personnalisez l’apparence et le ressenti de votre site.

Ajouter un domaine personnalisé

Configurez un domaine personnalisé pour votre site.

Mettre à jour les paramètres de votre site

Mettez à jour les paramètres liés à votre site publié.

Publiez votre documentation

Enfin, vous êtes prêt à publier votre site dans le monde entier. Si vous n’avez pas encore publié votre site depuis l’assistant, vous pouvez le faire à tout moment depuis le tableau de bord de votre site.

Après avoir publié votre site, vous recevrez un lien que vous pourrez partager avec n’importe qui !

Si vous rencontrez des problèmes ou si vous avez des questions, nous sommes là pour vous aider. Rejoignez notre communauté ou envoyez un message à notre équipe de support et nous vous aiderons à partir de là.