Interface GitBook

GitBook est divisé en plusieurs sections pour vous permettre d’organiser et de gérer plus facilement le contenu que vous créez.

Barre latérale

La barre latérale vous permet d’avoir 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 passer de l’une à l’autre ici. Vous pouvez également créer une nouvelle organisation à partir de 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 recevrez 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 parcourir 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 en cours, 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 Docs que vous avez créés dans votre organisation.

• Intégrations GitBook intégrations dynamisent 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 Docs Activez cette section pour voir tous les sites Docs dans votre organisation directement dans la barre latérale et accéder à l'un d'eux en un clic.

• Espaces La section des espaces est l'endroit où vous trouverez les collections et espaces que vous créez en ajoutant du contenu. Rendez-vous dans notre structure de contenu section 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/désactiver 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 quoi, ils sont définitivement supprimés.

Table des matières

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 visualiser 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 des groupes de pages

• Ajouter des liens externes

• importer des docs externes comme des sites Web ou des fichiers Markdown

• Accéder au menu Actions

  

  pour des pages individuelles.

Dans l’onglet Contenu réutilisable dans l’onglet, vous pouvez :

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

• Créer un 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 dans l’onglet, vous pouvez :

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

• Glisser-déposer d'autres fichiers dans votre espace

• Gérer des fichiers individuels

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

En-tête 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 choses telles que 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 comprend :

• L'emoji ou l'icône de l'espace Vous pouvez choisir un emoji ou une icône pour votre espace, afin de pouvoir 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, ainsi que dans votre documentation si jamais vous choisissez de la publier.

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

• Menu Actions

  

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

• Vue Éditeur Cette vue vous permet de modifier votre contenu à l'aide de l'éditeur basé sur des blocs de GitBook.

• Vue des modifications Cette vue met en évidence les modifications apportées dans une demande de modification grâce à l'affichage des différences. C'est idéal pour examiner le nouveau contenu avant de fusionner votre demande de modification afin de mettre les modifications en ligne.

• Aperçu Cette vue vous permet d'obtenir 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 pour indiquer la couleur de leur curseur. Cliquez sur un avatar pour accéder directement à la page qu'ils consultent.

• Configuration de la synchronisation Git La Synchronisation GitHub et GitLab configuration pour 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 Consultez les commentaires et discussions que vous et votre équipe avez eus concernant le 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éez, mettez à jour et supprimez des demandes de modification dans votre espace.

• Historique de l'espace Affichez l'historique des versions qui inclut toutes les modifications apportées à l'espace — ou dans 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 de faire des choses comme consulter 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 comprend :

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

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

• Menu Actions

  

  Propose une liste d'actions pour votre site. Vous pouvez visiter votre site ou copier son URL rapidement depuis ce menu.

• Vue d'ensemble La vue d'ensemble du site vous présente les informations essentielles sur votre site, y compris son URL, son statut de publication, son audience et son contenu, ainsi que des statistiques de haut niveau.

• Statistiques Le panneau de statistiques vous fournit des analyses détaillées sur votre site et ses performances.

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

• Paramètres Accédez aux paramètres du site et contrôlez 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 Ce bouton ouvre une fenêtre modale qui vous permet d'installer et de configurer des intégrations pour votre site.

• Accès des membres Visualisez et gérez qui peut accéder à votre site dans l'application GitBook, et quelles permissions ils détiennent.

• Visiter le site Cliquez ici pour ouvrir instantanément votre site Docs 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 certaines intégrations.

Titre et description de la page

En haut de chaque page, vous pouvez définir un titre, ajouter un(e) emoji, et écrire une description. 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 jusqu’à 200 caractères et servira de texte d’aperçu pour votre page dans les moteurs de recherche.

Menu des actions de la page

Le menu Actions de la page vous permet de dupliquer, renommer ou supprimer votre page.

Vous pouvez ouvrir le menu Actions 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.

Options de la page

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 panneau latéral Options de la page en ouvrant le menu Actions 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.

Plan de la page

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.

Tout bloc Titre 1 ou Titre 2 que vous ajoutez à la page apparaîtra 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 panneau latéral Options de la page.