Interface GitBook

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

GitBook est divisé en différentes sections afin de 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 bien plus encore.

La barre latérale vous permet d’avoir un aperçu de votre organisation 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 passer de l’une à l’autre ici. Vous pouvez également créer une nouvelle organisation depuis ce menu.

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

• Poser une question ou rechercher Propulsé par GitBook AI, 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 les commentaires, les modifications récentes des pages et plus encore.

• Accueil des sites de documentation Cliquez ici pour visiter la page de présentation de tous les sites de documentation que vous avez créés dans votre organisation.

• Intégrations GitBook les intégrations donnent un coup de boost à votre contenu, en 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 de documentation Développez cette section pour afficher tous les sites de documentation de votre organisation directement dans la barre latérale et y accéder en un clic.

• Espaces La section des espaces est l’endroit où vous trouverez les collections et espaces que vous créez en ajoutant davantage de contenu. Rendez-vous dans notre section 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 activer le mode clair/sombre, ou obtenir de l’aide auprès de notre équipe de support si nécessaire.

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

Table des matières

La table des matières liste toutes les pages et tous 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 consulter et gérer les contenus réutilisables et fichiers de votre espace.

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

• Créer de nouvelles pages et sous-pages

• Créer des groupes de pages

• Ajoutez des liens externes

• Accès le menu Actions pour les pages individuelles.

Dans la Bibliothèque onglet, vous pouvez :

• Consulter et rechercher du contenu réutilisable, des variables, des images et des fichiers dans l’espace

• Consulter et insérer du contenu réutilisable provenant 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 dans la page

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

• 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 :

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 l’ Masquer bouton qui apparaît. Pour l’afficher de nouveau, placez votre curseur près du bord de la page et cliquez sur l’ Afficher bouton .

En-tête de l’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 notamment de publier et partager votre espace, consulter 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 actuellement.

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

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

L’en-tête de l’espace dans 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 et quand vous choisirez de la publier.

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

• menu Actions

  Propose une liste d’actions pour votre espace. Semblables aux actions de page, les actions disponibles pour un espace varient selon le mode dans lequel vous vous trouvez actuellement.

• Aperçu Lorsque vous consultez une demande de modification, cet onglet affiche le titre et la description de la demande de modification, ainsi que les participants et les relecteurs. Il affiche également tous les changements et commentaires.

• Vue Éditeur Dans cette vue, vous pouvez modifier votre contenu à l’aide de l’éditeur en blocs de GitBook.

• Vue des modifications Cette vue met en évidence les modifications effectuées dans une demande de modification à l’aide de la vue diff. C’est idéal pour relire du nouveau contenu avant de fusionner votre demande de modification afin de publier les changements.

• 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 de votre espace, avec des cercles colorés pour indiquer la couleur de son curseur. Cliquez sur un avatar pour accéder à la page qu’elle consulte actuellement.

• Configuration de Git Sync La Synchronisation GitHub et GitLab 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 les modifications dans un espace avec Agent GitBook.

• les commentaires Consultez le les commentaires et discussions que vous et votre équipe avez eus au sujet 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 Consulter un historique des versions qui inclut toutes les modifications apportées à l’espace — ou à votre demande de modification actuelle — au fil du temps.

• Le bouton Modifier Si votre espace est publié, ou si quelqu’un a verrouillé les modifications en direct, le Modifier bouton 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 notamment de consulter les analyses du site, personnaliser votre site, modifier ses paramètres et prévisualiser le site dans différents modes et différentes tailles d’écran. Vous pouvez également configurer les intégrations et gérer les accès des membres.

L’en-tête du site comprend :

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

• Le fil d’Ariane du site Un lien de retour vers l’écran principal des sites de documentation.

• Aperçu La vue d’ensemble du site vous montre les informations essentielles à propos de votre site, notamment son URL, son statut de publication, son audience et son contenu, ainsi que des statistiques générales.

• Analyses La le panneau d’analyses vous donne des analyses détaillées sur votre site et ses performances.

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

• Paramètres Accédez aux paramètres de votre site et gérez 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 ordinateur comme sur mobile.

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

• Accès des membres Consultez et gérez qui peut accéder à votre site dans l’application GitBook, ainsi que les autorisations dont ils disposent.

• 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 mode multiutilisateur, ce qui signifie que vous et votre équipe pouvez collaborer sur les modifications en temps réel.

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

En plus de travailler sur les modifications, vous pouvez également commenter des blocs, mentionner 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 emojifacultatif, et rédiger une description. Le titre que vous utilisez apparaîtra dans la table des matières et formera le slug d’URL de votre page lorsqu’elle sera publiée.

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 d’URL d’une page en choisissant Actions de page > Renommer. En savoir plus sur Actions de page ci-dessous.

Menu d’actions de la page

Les menu Actions vous permettent par exemple de dupliquer, renommer ou supprimer votre page.

Vous pouvez ouvrir le menu Actions à l’aide de 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 du fait que vous soyez en mode édition en direct ou en demande de modification.

Options de page

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

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.

Vous pouvez ouvrir le Options de page panneau latéral en ouvrant le menu d’actions de la page et en choisissant Options, ou en survolant le titre principal de la page et en cliquant sur Options de page lorsqu’il apparaît.

Certains changements, comme 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

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

La plan de la page se trouve sur le côté droit de l’éditeur et permet d’accéder facilement directement à la section de la page que vous recherchez.

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

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

Si vous ne voyez pas la colonne de droite de l’application, c’est peut-être parce que la fenêtre de votre navigateur fait moins de 1430 pixels de large. La fenêtre de votre navigateur doit mesurer au moins 1430 pixels de large pour voir et utiliser le plan de la page.