Glossaire

Un

Menu des actions : Le menu qui s’ouvre lorsque vous cliquez sur les trois points à côté d’une page ou d’un élément dans l’interface GitBook. Le menu des actions peut afficher différentes options selon votre mode d’affichage actuel.

Ajouter un nouveau : Le bouton/menu en bas de la table des matières d’un espace qui vous permet d’ajouter du nouveau contenu à votre espace. Également utilisé pour désigner les + boutons à côté des Sites de documentation et Espaces titres de section dans la barre latérale, sur lesquels vous pouvez cliquer pour créer un nouveau site, espace ou collection.

Demander ou rechercher : L’outil de recherche de contenu dans GitBook. Vous pouvez cliquer en haut de la barre latérale pour l’ouvrir, ou appuyer sur ⌘ + K. Vous pouvez saisir un mot-clé pour une recherche standard, ou poser une question à l’aide de GitBook AI, qui résumera un résultat en fonction de votre contenu.

paramètres d’audience : Les paramètres qui déterminent qui peut accéder à un site de documentation publié. Voir Publier un site de documentation pour plus d’informations sur les options du menu Paramètres d’audience.

B

bloc : Chaque élément de contenu que vous ajoutez à une page existe dans un bloc. Il existe de nombreux types de blocs différents, vous permettant d’ajouter du texte, des images, des tableaux, du code, des références d’API, du contenu intégré et bien plus encore. Vous pouvez déplacer un bloc en le faisant glisser, modifier ses paramètres et, dans certains cas, changer un bloc en un autre type, depuis le menu Options.

C

demande de modification : Les demandes de modification sont similaires aux pull requests dans GitHub. Elles vous permettent de travailler en parallèle sur plusieurs branches d’un même espace, tout en conservant la version originale intacte. Dans GitBook, vous pouvez créer une nouvelle demande de modification et apporter des modifications à un espace, puis soumettre vos changements pour révision. Ces changements n’apparaîtront pas dans l’espace principal tant que quelqu’un n’aura pas fusionné cette demande de modification.

collection : Un groupe d’espaces. Vous pouvez considérer les collections comme un dossier pour vos espaces.

menu contextuel : Le menu qui apparaît au-dessus du texte sélectionné dans l’éditeur. Vous pouvez l’utiliser pour mettre votre texte en forme de plusieurs façons, notamment en gras, en italique et en code, ou pour ajouter des liens ou des annotations à votre contenu.

Commentaires : Un panneau latéral qui vous permet d’ajouter un commentaire à n’importe quel bloc d’une page. Vous pouvez répondre aux commentaires pour créer une discussion, mentionner des personnes avec @ et ajouter des emojis à vos commentaires. Vous pouvez également réagir aux commentaires avec un emoji, résoudre les commentaires qui ne sont plus pertinents et filtrer pour n’afficher que les commentaires dont vous avez besoin.

couverture : Une image située en haut d’une page. Vous pouvez ajouter une couverture à n’importe quelle page et la définir pour qu’elle occupe toute la largeur de votre page, ou seulement la largeur de votre contenu, comme image de héros. Voir Pages pour en savoir plus.

domaine personnalisé : Une URL personnalisée que vous pouvez configurer pour un site de documentation, par ex. docs.votreentreprise.com. Vous pouvez le configurer dans le Paramètres panneau de votre site de documentation. Voir Définir un domaine personnalisé pour en savoir plus.

D

vue des différences : Un interrupteur qui met en évidence les pages et les blocs qui ont été ajoutés, modifiés ou supprimés dans une demande de modification. Vous pouvez l’activer à l’aide du Voir les modifications bouton dans l’ en-tête de l’espace.

discussions : Lorsque vous répondez à un commentaire, vous créez une discussion — en pratique une conversation en fil de discussion dans le panneau latéral Commentaires.

site de documentation : Un site publié contenant les informations rédigées dans l’éditeur GitBook. Les sites de documentation sont accessibles aux utilisateurs sans compte GitBook.

domaine : La base de l’URL d’un site de documentation. Vous pouvez la personnaliser depuis la section Domaines dans le Paramètres page. La définition d’un domaine personnalisé remplacera ce paramètre.

E

éditeur : L’interface GitBook que vous voyez lorsque vous vous connectez à l’application. L’éditeur basé sur des blocs de GitBook offre la prise en charge de Markdown et des outils d’édition WYSIWYG, et vous pouvez ajouter et déplacer des blocs sur la page.

F

fichiers : Images, vidéos et autres éléments que vous pouvez téléverser dans un espace. Vous pouvez afficher et gérer vos fichiers en ouvrant l’onglet Fichiers en haut de la table des matières à gauche de votre contenu

G

Git Sync : Synchronisation Git vous permet de synchroniser des dépôts GitHub ou GitLab avec GitBook et de transformer des fichiers Markdown en documentation. Il s’agit d’une synchronisation bidirectionnelle, donc les modifications que vous apportez dans GitBook apparaissent dans votre dépôt, et les modifications que vous apportez directement dans GitHub ou GitLab seront mises à jour dans GitBook. Vous pouvez configurer Git Sync en ajoutant les intégrations GitHub Sync ou GitLab Sync à votre organisation. En savoir plus

GitBook AI : Un assistant IA entraîné sur votre base de connaissances et votre documentation pour répondre aux questions. Vous pouvez poser n’importe quelle question à GitBook AI au sujet de votre documentation depuis le menu Poser une question ou rechercher . Vous pouvez également demander à GitBook AI de vous aider à rédiger ou modifier votre contenu dans l’éditeur.

I

palette en ligne : Tapez / lors de au milieu d’un bloc dans le menu éditeur pour ouvrir la palette en ligne. Elle vous permet d’ajouter rapidement différents types de contenu en ligne à votre bloc, depuis des images et des emojis jusqu’aux mathématiques et au TeX.

palette d’insertion : Tapez / dans un bloc vide pour ouvrir la palette d’insertion. Elle affiche tous les blocs disponibles que vous pouvez créer, y compris les plugins et le contenu réutilisable. Vous pouvez rechercher un bloc pour affiner la sélection, puis le sélectionner avec votre clavier ou le curseur.

analyses : Les outils d’analyse intégrés de GitBook pour les sites de documentation, qui vous permettent de voir les pages vues, les retours et les recherches populaires sur vos espaces publiés.

intégrations : Les intégrations GitBook vous permettent de connecter vos espaces GitBook à des services et plateformes tiers. Vous pouvez installer des intégrations dans n’importe quel espace de votre organisation depuis le menu Intégrations.

L

modifications en direct : La possibilité d’apporter des modifications à une version en direct d’un document, sans créer de demande de modification. C’est l’option par défaut pour les espaces GitBook non publiés.

modifications en direct verrouillées : Lorsque vous verrouillez les modifications en direct, les personnes devront créer une demande de modification afin d’apporter des modifications à un document dans GitBook. Cela permet d’éviter les erreurs et de maintenir de bonnes pratiques de travail pour les documents importants. Vous pouvez verrouiller les modifications en direct pour n’importe quel espace — et cela est automatiquement activé pour les espaces publiés.

M

gestion des membres : Des outils qui vous permettent d’afficher et de modifier les membres de votre organisation, y compris leurs droits d’administrateur et les espaces auxquels ils ont accès.

O

menu Options : Le menu qui s’ouvre lorsque vous cliquez sur les six points à côté d’un bloc. Ici, vous pouvez modifier l’apparence d’un bloc. Cliquez et faites glisser les six points pour déplacer le bloc sur la page.

P

page : Un endroit où vous pouvez ajouter ou rédiger votre contenu à l’aide de blocs. Les pages se trouvent dans un espace, et vous pouvez donner à chaque page un titre et une icône ou un emoji facultatif.

groupe de pages : Un moyen de regrouper des pages. Vous pouvez définir un nom et une icône ou un emoji facultatif pour chaque groupe de pages.

options de page : Un ensemble d’options que vous pouvez définir pour vos pages à l’aide du Options de page panneau latéral. Vous pouvez sélectionner un modèle de mise en page ou contrôler des options individuelles telles que masquer le titre et la description de la page, la table des matières ou le plan de la page. En savoir plus dans Pages.

R

contenu réutilisable : Contenu synchronisé à plusieurs emplacements dans un espace. Lorsque vous créez du contenu réutilisable vous pouvez l’ajouter à un espace autant de fois que nécessaire, puis modifier toutes ces instances en même temps. Vous pouvez afficher et gérer le contenu réutilisable d’un espace depuis l’onglet Contenu réutilisable en haut de la table des matières.

S

barre latérale : La zone tout à gauche de votre fenêtre GitBook. Elle contient la Poser une question ou rechercher barre, tous vos sites de documentation, espaces et collections, ainsi que des éléments comme les notifications, les intégrations et les paramètres.

section du site : Si vous souhaitez que votre site de documentation fonctionne davantage comme un hub de contenu, vous pouvez publier plusieurs espaces sur le même site de documentation sous forme de sections du site. Ces sections du site apparaîtront dans une barre d’onglets en haut de votre documentation publiée, permettant aux utilisateurs de passer d’un contenu à l’autre. Vous pouvez configurer les sections du site dans la Structure section de Paramètres du site.

slug : La partie finale personnalisable d’une URL, généralement après le domaine et un /. Dans un site de documentation, elle est déduite du titre du site et vient après le domaine. Vous pouvez la personnaliser davantage si nécessaire depuis le Domaines section de Paramètres du site.

espace : Une zone où vous pouvez organiser du contenu connexe. Elle peut contenir une seule page ou plusieurs pages, des sous-pages et des groupes de pages.

en-tête de l’espace : La barre de menu sous l’aperçu de l’espace lorsque vous consultez un espace. Elle contient le titre et l’icône de l’espace, ainsi que des boutons pour afficher les commentaires, les liens rompus et les demandes de modification, ainsi que le Modifier dans une demande de modification .

aperçu de l’espace : La barre de menu en haut de l’application GitBook lorsque vous consultez un espace. Elle contient le fil d’Ariane de l’espace dans lequel vous vous trouvez, ainsi que le Synchronisation Git bouton de configuration, le bouton Partager et le bouton Actions de l’espace. Si d’autres personnes travaillent dans l’espace en même temps que vous, vous verrez également leurs avatars ici.

sous-page : Une page imbriquée dans une autre page, contenant généralement du contenu connexe.

T

table des matières : La liste des pages de document, des liens et des groupes qui composent un espace. Vous la trouverez à gauche de votre page, à côté de la barre latérale. La table des matières (TOC) permet également d’accéder au contenu réutilisable et fichiers. Vous pouvez la réduire en survolant le coin supérieur droit de la TOC.

V

variante: Un variante est une version différente de votre documentation — par exemple, une version traduite de vos docs, ou des docs pour un numéro de version différent de votre produit. Les lecteurs du site peuvent passer d’une variante à l’autre à l’aide d’un menu déroulant sur le site publié.

version : Un instantané enregistré de votre espace à un moment précis. Vous pouvez accéder aux versions précédentes de votre espace dans l’ historique des versions .

Historique des versions : Un menu affichant les événements majeurs d’un espace — comme sa date de création, toutes les demandes de modification que vous avez fusionnées, et chaque fois que quelqu’un est revenu à une version précédente. Vous pouvez cliquer sur n’importe quelle version pour voir à quoi ressemblait l’espace à ce moment-là, et revenir à une version précédente si nécessaire.