Interface GitBook

Découvrez les différents composants et l’interface dans 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

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 votre organisation GitBook d'un seul 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 tout ce sur quoi votre équipe travaille d'un seul coup d'œil. Affichez les demandes de modification ouvertes, les discussions et commentaires, les dernières modifications de pages, et plus encore.

• Accueil des sites de documentation 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 GitBook améliorent votre contenu, vous permettant d'intégrer davantage dans vos pages ou d'ajouter des informations à votre base de connaissances depuis d'autres applications.

• Sites de documentation 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 d'un clic.

• Espaces La section des 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 section pour en savoir plus.

• Paramètres Vous trouverez 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 sept jours — après cela, ils sont définitivement supprimés.

Table des matières

La table des matières répertorie toutes les pages et 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 :

• Créer de nouvelles pages et sous-pages

• Créer groupes de pages

• Ajouter 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 l'espace

• Afficher et insérer du contenu réutilisable depuis d'autres espaces

• Créer ou importer de nouveaux éléments dans la Bibliothèque

• Glisser-déposer des éléments de la Bibliothèque sur la page

• Double-cliquer pour renommer n'importe quel élément de la Bibliothèque

• Aperçu des images

• Gérer et télécharger des images et des fichiers

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

Si vous souhaitez donner plus de visibilité au contenu de votre page, vous pouvez masquer temporairement la table des matières en survolant votre curseur à côté et en cliquant sur le Masquer bouton qui apparaît. Pour la faire réapparaître, survolez le bord de la page avec votre curseur et cliquez sur le Afficher bouton .

En-tête d'espace

L'en-tête de l'espace se trouve en haut de l'éditeur et propose 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 publier et partager votre espace, de voir les commentaires et l'historique de l'espace, de 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 un aperçu de la demande de modification, ainsi que des options pour ouvrir l'éditeur, voir les modifications et fusionner votre demande de modification.

Si vous consultez un espace en lecture seule, vous devrez ouvrir une nouvelle demande de modification pour modifier le contenu de la page car les modifications en direct sont verrouillées.

L'en-tête de l'espace à l'intérieur d'une demande de modification.

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

• 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 de documentation dans lesquels l'espace se trouve.

• Menu Actions

  Propose une liste d'actions pour votre espace. Similaire aux actions de page, les actions disponibles pour un espace diffèrent en fonction du mode dans lequel vous vous trouvez.

• Aperçu Lors de la consultation d'une demande de modification, cet onglet affiche le titre et la description de la demande de modification, ainsi que les participants et les réviseurs. Il affiche également toutes les modifications et commentaires.

• Vue éditeur Cette vue est l'endroit où vous pouvez modifier votre contenu en utilisant l'éditeur par blocs de GitBook.

• Vue des modifications Cette vue met en évidence les modifications apportées dans une demande de modification en utilisant la vue diff. C'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 autre personne qui consulte 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 partager votre espace. Vous pouvez également inviter d'autres personnes à collaborer via ce menu.

• Variables Créer et ajouter des variables réutilisables à utiliser dans un espace.

• Agent GitBook Collaborez sur des modifications dans un espace avec Agent GitBook.

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

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

• Historique de l'espace Afficher 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 une nouvelle 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 insights du site, de personnaliser votre site, de modifier ses paramètres et d'apercevoir 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 à l'écran principal des Sites de documentation.

• Aperçu 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éder aux paramètres du site et contrôler le nom, l'audience, la structure du contenu et d'autres options.

• Aperçu L'onglet aperçu vous permet de voir rapidement à quoi ressemblera votre site publié en mode clair et sombre sur les écrans 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 permissions 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

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

L'éditeur est la partie principale de votre espace, où vous pouvez écrire ou insérer du contenu dans GitBook. Il prend en charge le travail en collaboration en temps réel, ce qui signifie que vous et votre équipe pouvez collaborer sur des modifications en temps réel.

Vous pouvez insérer blocs de contenu, taper Markdown, intégrer du contenu, et collaborer sur les modifications avec Agent GitBook.

En plus de travailler sur des modifications, vous pouvez également commenter des blocs, taguer des coéquipiers, et plus encore.

Titre et description de la page

En haut de chaque page, vous pouvez définir un titre, ajouter un emojioptionnel et écrire unedescription

. Le titre que vous utilisez apparaîtra dans la table des matières et formera le slug de l'URL de votre page lors de la publication.

La description de votre page peut comporter 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 pageRenommer Vous pouvez modifier le slug URL d'une page en choisissant . En savoir plus sur

ci-dessous.

Menu des actions de page Menu Actions Le

de la page vous permet de faire des choses comme dupliquer, renommer ou supprimer votre page. Menu Actions Vous pouvez ouvrir le en utilisant l'

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 de si vous êtes en mode d'édition en direct demande de modification.

ou en

La ou en Options de la page

le panneau latéral offre des options de personnalisation pour votre documentation et votre navigation.

de la page vous permet de faire des choses comme dupliquer, renommer ou supprimer votre page. ou en Avec les options de page, vous pouvez personnaliser la mise en page et la navigation de votre documentation. Vous ne pouvez accéder aux options de page que si vous êtes en mode édition. ouvrez le panneau latéral en ouvrant le Menu d'action de la page et en choisissantOptions ou en , ou en survolant le titre principal de la page et en cliquant sur

lorsqu'il apparaît.

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

Plan de la page

La Le plan de la page affiche les titres H1 et H2, vous permettant de sauter rapidement à une section spécifique d'une page individuelle. le plan de la page

se trouve sur le côté droit de l'éditeur et facilite l'accès direct à la section de la page que vous recherchez. Tous les titres

que vous ajoutez à la page apparaîtront dans le plan de la page listé ici. ou en Le plan de la page apparaîtra également sur votre site publié. Vous pouvez l'activer ou le désactiver dans le

panneau latéral.