Interface GitBook

En savoir plus sur les différents composants et l’interface dans l’éditeur de GitBook

Découvrez les différents composants et l'interface utilisateur de l'éditeur GitBook

GitBook est divisé en différentes sections pour faciliter l'organisation et la gestion du contenu que vous créez.

Barre latérale

A GitBook screenshot showing the sidebar
La barre latérale de GitBook contient toute votre documentation, ainsi que les notifications, la barre de recherche, les extraits et plus encore.

La barre latérale vous permet de voir un aperçu de l'organisation de votre GitBook en un coup d'œil. La barre latérale contient :

  • Sélecteur d'organisation Si vous faites partie de plusieurs organisations, vous pouvez les voir et basculer entre elles ici. Vous pouvez également créer une nouvelle organisation depuis ce menu.

  • Notifications Lorsque vous êtes tagué dans un commentaire ou une conversation, ou lorsqu'il y a une activité importante dans un espace sur lequel vous travaillez, vous recevrez une notification pour vous montrer ce qui est nouveau.

  • Demander ou rechercher Propulsé par GitBook IA, vous pouvez poser des questions en langage naturel ou rechercher dans les différents espaces et contenus de votre organisation.

  • Accueil La page d'accueil vous permet de voir en un coup d'œil tout ce sur quoi votre équipe travaille. Consultez les demandes de modification ouvertes, les discussions et commentaires, les récentes modifications de pages et plus encore.

  • Accueil des sites Docs Cliquez ici pour visiter la page d'aperçu de tous les sites de documentation que vous avez créés dans votre organisation.

  • Intégrations Les intégrations de GitBook renforcent votre contenu, vous permettant d'intégrer davantage d'éléments dans vos pages ou d'ajouter des informations à votre base de connaissances depuis d'autres applications.

  • Sites Docs Activez cette section pour afficher tous les sites de documentation de votre organisation directement dans la barre latérale et accéder à l'un d'eux en un clic.

  • Espaces La section Espaces est l'endroit où vous trouverez les collections et espaces que vous créez lorsque vous ajoutez plus de contenu. Rendez-vous dans notre structure du contenu pour en savoir plus.

  • Paramètres Vous trouverez les paramètres personnels et paramètres de l'organisation en bas de la barre latérale. Ici, vous pouvez également basculer entre le mode clair/sombre ou obtenir de l'aide de notre équipe de support si nécessaire.

  • Corbeille Les espaces supprimés apparaissent dans la corbeille. Vous pouvez les restaurer pendant jusqu'à sept jours — après cela, ils sont définitivement supprimés.

Table des matières

A GitBook screenshot showing the table of contents
La table des matières répertorie toutes les pages et les liens de l'espace sélectionné.

Par défaut, la table des matières affiche une liste de pages, liens et groupes qui composent un espace. Vous la trouverez à droite de la barre latérale. Elle est spécifique à l'espace que vous consultez actuellement.

La table des matières est également l'endroit où vous pouvez afficher et gérer contenu réutilisable et fichiers pour votre espace.

Depuis l'onglet Pages dans la table des matières, vous pouvez :

Dans l'onglet Contenu réutilisable , vous pouvez :

  • Afficher et rechercher le contenu réutilisable dans l'espace

  • Créer du nouveau contenu réutilisable

  • Glisser-déposer du contenu réutilisable sur la page

  • Renommer et supprimer le contenu réutilisable

Dans l'onglet Fichiers , vous pouvez :

  • Afficher, rechercher et réorganiser les fichiers dans votre espace

  • Glisser-déposer davantage de fichiers dans votre espace

  • Gérer les fichiers individuels

Si vous souhaitez donner plus d'importance au contenu de votre page, vous pouvez temporairement masquer la table des matières en plaçant votre curseur à côté et en cliquant sur le Masquer bouton The Hide button icon in GitBook qui apparaît. Pour la faire réapparaître, placez votre curseur près du bord de la page et cliquez sur le Afficher bouton The Show button icon in GitBook.

En-tête de l'espace

A GitBook screenshot showing the space header
L'en-tête de l'espace se trouve en haut de l'éditeur et offre des options qui s'appliquent à l'ensemble de l'espace.

L'en-tête de l'espace contient des informations sur l'espace que vous consultez actuellement. Il vous permet de faire des actions comme publier et partager votre espace, voir les commentaires et l'historique de l'espace, configurer la synchronisation GitHub ou GitLab, et plus encore.

L'en-tête de l'espace est adaptable et change en fonction de l'espace et du mode dans lequel vous vous trouvez.

Par exemple, si vous modifiez une demande de modification, vous verrez des options pour ouvrir l'éditeur, afficher les modifications et fusionner votre demande de modification. Si vous consultez un espace en lecture seule, vous aurez la possibilité d'ouvrir une nouvelle demande de modification, mais vous n'aurez pas d'option d'éditeur.

L'en-tête de l'espace inclut :

  • L'emoji ou l'icône de l'espace Vous pouvez choisir un emoji ou une icône pour votre espace, afin de l'identifier facilement dans la barre latérale.

  • Le nom de l'espace Le nom de l'espace qui apparaîtra dans la barre latérale et dans votre documentation si vous choisissez de la publier.

  • Les fil d'Ariane de l'espace Une liste complète et linéaire des collections ou sites Docs dans lesquels l'espace se trouve.

  • Menu Actions The Actions menu icon in GitBook Propose une liste d'actions pour votre espace. Semblable aux actions de page, les actions disponibles pour un espace varieront en fonction du mode dans lequel vous vous trouvez.

  • Vue éditeur Cette vue est l'endroit où vous pouvez apporter des modifications à votre contenu en utilisant l'éditeur basé sur des blocs de GitBook.

  • Vue des modifications Cette vue met en évidence les modifications effectuées dans une demande de modification en utilisant la vue diff. Cela est idéal pour revoir le nouveau contenu avant de fusionner votre demande de modification afin de rendre les changements publics.

  • Aperçu Cette vue vous permet de voir rapidement un aperçu de votre contenu avant de fusionner une demande de modification.

  • Collaborateurs L'avatar de toute personne consultant actuellement une page dans votre espace, avec des cercles colorés indiquant la couleur de leur curseur. Cliquez sur un avatar pour accéder à la page qu'ils consultent actuellement.

  • Configuration de la synchronisation Git La synchronisation GitHub et GitLab pour la configuration de votre espace.

  • Le menu Partager Vous permet de publier et de partager votre espace. Vous pouvez également inviter d'autres personnes à collaborer via ce menu.

  • Commentaires Voir les commentaires et discussions que vous et votre équipe avez eus au sujet du contenu de l'espace.

  • Liens brisés Tous les liens brisés qui ont été trouvés dans l'espace ou la demande de modification en cours.

  • Demandes de modification Créer, mettre à jour et supprimer des demandes de modification dans votre espace.

  • Historique de l'espace Voir un historique des versions qui inclut toutes les modifications apportées dans l'espace — ou dans votre demande de modification en cours — au fil du temps.

  • Le bouton Modifier Si votre espace est publié, ou si quelqu'un a verrouillé les modifications en direct, le bouton Modifier apparaîtra dans l'en-tête de l'espace. Il créera un nouveau demande de modification pour modifier le contenu.

En-tête du site

L'en-tête du site contient des informations sur le site que vous consultez actuellement. Il vous permet de voir les statistiques du site, personnaliser votre site, modifier ses paramètres et prévisualiser le site dans différents modes et tailles d'écran. Vous pouvez également configurer des intégrations et gérer l'accès des membres.

L'en-tête du site inclut :

  • Le nom du site Le nom de l'espace qui apparaîtra dans la barre latérale et dans votre documentation si vous choisissez de la publier.

  • Les fil d'Ariane du site Un lien de retour vers l'écran principal des Sites Docs.

  • Menu Actions The Actions menu icon in GitBook Propose une liste d'actions pour votre site. Vous pouvez visiter votre site ou copier son URL rapidement depuis ce menu

  • Aperçu général L'aperçu du site vous montre des informations essentielles sur votre site, y compris son URL, son statut de publication, son audience et son contenu, ainsi que des insights de haut niveau.

  • Insights La panneau d'insights vous donne des analyses détaillées sur votre site et ses performances.

  • Personnalisation Ici vous pouvez personnaliser votre site avec votre propre logo, couleurs, liens d'en-tête, et bien plus.

  • Paramètres Accédez aux paramètres de votre site et contrôlez le nom, l'audience, la structure du contenu et d'autres options.

  • Aperçu L'onglet de prévisualisation vous permet de voir rapidement à quoi ressemblera votre site publié en mode clair et sombre sur les affichages de bureau et mobiles.

  • Intégrations Le bouton ouvre une fenêtre modale qui vous permet d'installer et de configurer intégrations pour votre site.

  • Accès des membres Voir et gérer qui peut accéder à votre site dans l'application GitBook et quelles autorisations ils ont.

  • Visiter le site Cliquez ici pour ouvrir instantanément votre site de documentation publié dans un nouvel onglet. Ce bouton n'apparaît que lorsque votre site est en ligne.

Éditeur de contenu

L'éditeur est la partie principale de votre espace, où vous pouvez écrire ou insérer du contenu dans GitBook.

En plus des multiples blocs de contenu que vous pouvez insérer, vous pouvez également intégrer du contenu et utiliser certains intégrations.

Titre et description de la page

En haut de chaque page, vous pouvez définir un titre, ajouter un emoji, et rédiger une description. Le titre que vous utilisez apparaîtra dans la table des matières et formera le slug URL de votre page lors de la publication.

La description de votre page peut contenir au maximum 200 caractères et servira de texte d'aperçu pour votre page dans les moteurs de recherche.

Vous pouvez modifier le slug URL d'une page en choisissant Actions de la page The Actions menu icon in GitBook > Renommer. En savoir plus sur Actions de la page ci-dessous.

Le Menu Actions The Actions menu icon in GitBook de la page vous permet de faire des choses comme dupliquer, renommer ou supprimer votre page.

Vous pouvez ouvrir le Menu Actions en utilisant l' The Actions menu icon in GitBook icône qui apparaît lorsque vous survolez votre page dans la barre latérale, ou depuis l'icône à côté du titre de la page.

Le type d'actions disponibles dépendra du fait que vous soyez en mode d'édition en direct ou en demande de modification.

Options de la page

A GitBook screenshot showing the Page options side panel
La Options de la page le panneau latéral offre des options de personnalisation pour votre documentation et la navigation.

Avec les options de la page, vous pouvez personnaliser la mise en page et la navigation de votre documentation. Vous ne pouvez accéder aux options de la page que si vous êtes en mode édition.

Vous pouvez ouvrir le Options de la page ouvrez le panneau latéral en ouvrant le Menu d'action The Actions menu icon in GitBook de la page et en choisissant Options, ou en survolant le titre principal de la page et en cliquant sur Options de la page lorsqu'il apparaît.

Certaines modifications, comme la désactivation de la table des matières, s'appliquent uniquement à la documentation publiée et peuvent ne pas être visibles dans l'éditeur.

Plan de la page

A GitBook screenshot showing the page outline
Le plan de la page affiche les titres H1 et H2, vous permettant de vous rendre rapidement à une section spécifique d'une page individuelle.

La plan de la page se trouve du côté droit de l'éditeur et facilite l'accès direct à la section de la page que vous recherchez.

Tous les les titres que vous ajoutez à la page apparaîtront dans le plan de la page listé ici.

Le plan de la page apparaîtra également sur votre site publié. Vous pouvez l'activer ou le désactiver dans le Options de la page panneau latéral.

Si vous ne voyez pas la colonne de droite de l'application, cela peut être dû au fait que la fenêtre de votre navigateur est inférieure à 1430 pixels de largeur. Votre fenêtre de navigateur doit mesurer au moins 1430 pixels de largeur pour voir et utiliser le plan de la page.

Mis à jour

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