Interface GitBook

Apprenez à naviguer dans GitBook

GitBook s’organise autour de vos sites de documentation. Vous commencez sur la page de votre organisation Accueil, ouvrez un site pour travailler sur son contenu et modifiez les pages dans les sections. Cette page présente chaque partie de l’interface.

Accueil

La page d’accueil de votre organisation vous donne accès aux sites, au contenu et aux contrôles de l’organisation.

Lorsque vous ouvrez GitBook, vous arrivez sur votre organisation Accueil: tous les sites de documentation de votre organisation, réunis au même endroit. Depuis cette page, vous pouvez ouvrir un site, en créer un nouveau ou ajuster les paramètres à l’échelle de l’organisation. L’accueil contient :

• Sélecteur Revenez à Accueil depuis n’importe où à l’aide du sélecteur en haut de la barre latérale. Si vous faites partie de plusieurs organisations, vous pouvez les consulter et passer de l’une à l’autre ici, ou créer une nouvelle organisation.
• Notifications Lorsque vous êtes identifié dans un commentaire ou une conversation, ou lorsqu’une activité importante a lieu dans une section sur laquelle vous travaillez, vous recevez une notification pour vous indiquer les nouveautés.
• Demander ou rechercher Propulsé par GitBook Agent, posez des questions en langage naturel ou effectuez des recherches dans les sites et le contenu de votre organisation.
• Liste des sites Affichez tous les sites de documentation de votre organisation. Cliquez sur un site pour l’ouvrir.
• Tout le contenu Si votre organisation possède du contenu qui ne fait partie d’aucun site, il apparaît dans une Tout le contenu section à côté de vos sites, sous forme d’arborescence. Si chaque élément de contenu appartient à un site, cette section n’apparaît pas.
• Paramètres Paramètres de l’organisation et paramètres du compte partagent un écran dédié. Il regroupe les paramètres par Compte et Organisation.

  Compte inclut Général, Notifications, Organisations, et Outils de développement. Organisation inclut Général, Membres, Règles de fusion, GitBook Agent, Intégrations, OpenAPI, Traductions, Liens d’invitation, Équipes, SSO, et Facturation. Cliquez sur Retour à l’application pour reprendre votre travail.
• Guides de style Affichez chaque guide de style de votre organisation et les sites qui l’utilisent.
• Corbeille Les sections supprimées apparaissent dans Corbeille. Vous pouvez les restaurer pendant un maximum de sept jours ; après cela, elles sont définitivement supprimées.

Barre latérale du site

L’ouverture d’un site remplace la barre latérale par le contenu et les outils de ce site : la même structure que celle que les visiteurs voient sur votre site publié. La barre latérale du site contient :

• En-tête du site Le nom et le statut de publication de votre site, ainsi que les boutons Aperçu et Publier .
• Général Vue d’ensemble, Demandes de modification, Structure du site, et Paramètres.
• Outils Guide de style, Personnaliser, Analyser, et Étendre. Chacun s’ouvre dans la vue principale.
• Contenu Les sections et groupes de votre site, dans l’ordre de publication. Cliquez sur une section pour la modifier.

  L’arborescence est en lecture seule. Réorganisez-la dans l’ éditeur de structure. Utilisez les icônes de recherche, de modification et + dans l’ Contenu en-tête pour rechercher, renommer et ajouter des sections.

Table des matières

La table des matières répertorie toutes les pages et tous les liens de la section sélectionnée.

Par défaut, la table des matières répertorie les pages, liens et groupes de pages de la section sélectionnée. Elle se trouve à droite de la barre latérale.

Vous pouvez également gérer le contenu réutilisable et fichiers de la section.

Depuis l’onglet Pages de la table des matières, vous pouvez :

• Créer de nouvelles pages et sous-pages.
• Créer des groupes de pages.
• Ajouter des liens externes.
• Accéder à au menu Actions pour les pages individuelles.

Dans l’onglet Bibliothèque , vous pouvez :

• Afficher et rechercher du contenu réutilisable, des variables, des images et des fichiers dans la section.
• Afficher et insérer du contenu réutilisable provenant d’autres sections.
• Créer ou importer de nouveaux éléments de la bibliothèque.
• Glisser-déposer des éléments de la bibliothèque sur la page.
• Double-cliquer sur un élément de la bibliothèque pour le renommer.
• Prévisualiser les images.
• Gérer et télécharger les images et les fichiers.

Voici une courte vidéo montrant ce que vous pouvez faire avec la table des matières, en particulier l’onglet Bibliothèque :

Pour vous concentrer sur le contenu de la page, survolez la zone à côté de la table des matières et cliquez sur Masquer . Pour l’afficher de nouveau, survolez le bord de la page et cliquez sur Afficher .

En-tête de section

L’en-tête de section se trouve en haut de l’éditeur et propose des options qui s’appliquent à l’ensemble de la section.

L’en-tête de section contient des informations sur la section que vous consultez actuellement. Il vous permet d’afficher les commentaires et l’historique, de configurer la synchronisation GitHub ou GitLab, et bien plus encore.

L’en-tête de section est adaptable, et change selon la section et le mode dans lesquels vous vous trouvez actuellement.

Par exemple, si vous modifiez une demande de modification, vous voyez un aperçu de la demande de modification, ainsi que des options pour ouvrir l’éditeur, afficher les modifications et fusionner votre demande de modification.

Si vous consultez une section en lecture seule, vous devez ouvrir une nouvelle demande de modification pour modifier la page, car les modifications en direct sont verrouillées.

L’en-tête de section dans une demande de modification.

L’en-tête de section inclut :

• L’emoji ou l’icône de la section Choisissez un emoji ou une icône pour votre section afin de l’identifier dans la barre latérale.
• Le nom de la section Ce nom apparaît dans la barre latérale et sur votre site publié.
• Le fil d’Ariane de la section Le site — et le groupe, s’il y en a un — auquel appartient la section.
• Menu Actions Propose des actions pour votre section. Comme pour les actions de page, les actions disponibles varient selon le mode de modification.
• Vue d’ensemble Dans une demande de modification, consultez son titre, sa description, ses participants, ses réviseurs, ses modifications et ses commentaires.
• Vue Éditeur Modifiez du contenu avec l’éditeur de GitBook basé sur des blocs.
• Vue Modifications Cette vue met en évidence les modifications dans une demande de modification à l’aide d’une vue différentielle. Examinez les modifications avant de les fusionner.
• Aperçu Prévisualisez le contenu avant de fusionner une demande de modification.
• Collaborateurs Affichez les avatars des personnes qui lisent les pages de la section. Cliquez sur un avatar pour ouvrir la page qu’elles consultent.
• Configuration de Git Sync Configurez GitHub et GitLab Synchronisation de la section.
• Le menu Partager Publiez et partagez votre section, ou invitez d’autres personnes à collaborer.
• Variables Créez des variables de la section.
• GitBook Agent Collaborez sur les modifications de la section avec GitBook Agent.
• Commentaires Afficher les commentaires et discussions sur le contenu de la section.
• Demandes de modification Créez, mettez à jour et supprimez des demandes de modification.
• Historique de la section Afficher les historique des versions pour la section ou la demande de modification.
• Le bouton Modifier Si une section est publiée ou que les modifications en direct sont verrouillées, Modifier crée une demande de modification.

Outils du site

Les outils du site s’ouvrent depuis la barre latérale du site dans la vue principale. L’en-tête du site conserve Aperçu et Publier.

Sous Général:

• Vue d’ensemble Les informations essentielles du site, y compris son URL, son statut de publication, son audience, son contenu et les principales informations analytiques. Une fois votre site en ligne, Vue d’ensemble renvoie vers celui-ci.
• Demandes de modification Les demandes de modification dans les sections de votre site.
• Structure du site Utilisez l’ éditeur de structure pour ajouter, réorganiser, publier et supprimer des sections et des groupes.
• Paramètres Paramètres du site incluent Général, Membres, Agents, Audience, Domaine et URL, Redirections, et Forfait.

Sous Outils:

• Guide de style Le guide de style de votre site définit les règles et conventions de rédaction. GitBook Agent les suit lorsqu’il rédige, modifie ou révise du contenu.
• Personnaliser Personnalisez votre site avec Thème, Mise en page, Assistant IA, et Configurez les options.
• Analyser Informations IA et Analyses fournissent des analyses détaillées sur votre site et ses performances.
• Étendre Connexions, Canaux, Intégration de documentation, Accès MCP, et Intégrations.

Éditeur de contenu

Rédigez du contenu et ajoutez des blocs dans l’éditeur GitBook.

L’éditeur est la partie principale de votre section. Rédigez et insérez du contenu, puis collaborez avec votre équipe en temps réel.

Insérer des blocs de contenu, écrire en Markdown, intégrer du contenu, et collaborer avec GitBook Agent.

Vous pouvez également commenter les blocs et identifier des coéquipiers.

Titre et description de la page

En haut de chaque page, définissez un titre, ajoutez un emoji facultatif et rédigez une description. Le titre apparaît dans la table des matières et constitue le slug d’URL publié.

La description de votre page peut contenir jusqu’à 200 caractères. Elle apparaît comme texte d’aperçu dans les moteurs de recherche.

Pour modifier le slug d’URL d’une page, ouvrez le Menu Actions de la page Modifier le titre et le slug.

Menu Actions de la page

Le Menu Actions de la page vous permet de dupliquer, renommer ou supprimer une page.

Dans la table des matières, survolez une page et cliquez sur l’icône . Vous pouvez également cliquer sur l’icône située à côté du titre de la page.

Les actions disponibles dépendent de votre utilisation de la modification en direct ou d’une demande de modification.

Options de la page

Le Options de la page panneau latéral offre des options de personnalisation pour votre documentation et votre navigation.

Utilisez les options de page pour personnaliser la mise en page et la navigation de la documentation. Les options de page sont disponibles uniquement lors de la modification.

Ouvrez Options de la page depuis le Menu Actions de la page en sélectionnant Options. Vous pouvez également survoler le titre de la page et cliquer sur Options de la page.

Certaines modifications, telles que la désactivation de la table des matières, apparaissent uniquement dans la documentation publiée.

Plan de la page

Le plan de la page affiche les titres H1 et H2, ce qui vous permet d’accéder rapidement à une section spécifique d’une page individuelle.

Le plan de la page se trouve sur le côté droit de l’éditeur. Il vous permet d’accéder à une section de la page.

Le plan répertorie les titres H1 et H2 de la page.

Le plan de la page apparaît également sur votre site publié. Activez-le ou désactivez-le dans le Options de la page panneau latéral.

Si la colonne de droite n’est pas visible, la largeur de la fenêtre de votre navigateur est peut-être inférieure à 1 430 pixels. Utilisez une fenêtre d’au moins 1 430 pixels de large pour afficher et utiliser le plan de la page.