Pages

Ajoutez des pages, des groupes de pages ou des liens externes — et découvrez les options disponibles pour chaque page

Une page est l'endroit où vous pouvez ajouter, modifier et intégrer du contenu. Les pages résident toujours à l'intérieur d'un espace, vous permettant de regrouper du contenu lié et de créer différentes sections pour les sujets ou domaines que vous couvrez.

Lors de la publication de votre documentation, chaque espace sera son propre site de documentation ou section du site, et les pages à l'intérieur de l'espace apparaîtront toutes sur ce site.

Table des matières

Vous pouvez créer autant de pages que nécessaire dans un espace. Elles sont toutes visibles dans la barre latérale gauche de votre écran dans le table des matièresde votre espace. La table des matières apparaîtra au même endroit lorsque vous publierez votre espace, à moins que vous choisissiez de la masquer.

circle-info

Page d'accueil du site Docs

La première page de votre table des matières est toujours la page d'accueil de votre espace, même si elle est masquée de la table des matières.

Créer une nouvelle page

Lorsque vous êtes en édition en direct mode ou en demande de changement, vous pouvez créer une nouvelle page en cliquant sur Ajouter un nouveau... > Page en bas de votre table des matières. Vous pouvez aussi survoler entre les pages dans la table des matières et cliquer sur l' + icône qui apparaît.

A GitBook screenshot showing an empty page listed in the table of contents
Une page vide dans GitBook. Vous pouvez la voir répertoriée dans la table des matières sur le côté gauche.

Vous ne voyez pas l'option pour créer une nouvelle page ?

circle-exclamation

Organisation de votre contenu

Il existe trois façons d'organiser votre contenu dans la table des matières :

Pages

Une page a un titre, une description optionnelle, et une zone où vous pouvez écrire et ajouter tout type de contenu.

Vous pouvez imbriquer des pages en faisant glisser et déposer une page sous une autre dans la table des matières. Cela crée une sous-page.

Si vous ajoutez des sous-pages à une page parente vide, GitBook générera automatiquement une page « contenu » avec des liens vers toutes les sous-pages dans la version publiée de votre documentation.

circle-info

Conseil : Il n'y a pas de limite à l'imbrication des pages, mais nous vous recommandons d'éviter plus de trois niveaux d'imbrication pour ne pas compliquer excessivement la navigation.

Lorsque vous changez le titre d'une page, le slug de la page (la partie à la toute fin de l'URL, par ex. /hello-world) changera également — à moins que vous n'ayez défini manuellement le slug de la page précédemment.

Vous pouvez modifier le titre, le titre de lien et le slug d'une page à tout moment en ouvrant le menu d’action The Actions menu icon in GitBook ouvrez le panneau latéral en ouvrant le Modifier le titre & le slug.

Titre du lien de la page

Si vous voulez que votre page ait un titre SEO plus long tout en conservant un titre plus court pour l'entrée de navigation et les liens, vous pouvez éventuellement définir un titre de lien.

Ouvrez le menu d’action The Actions menu icon in GitBook et choisissez Modifier le titre & le slugde la page. Dans la Modifier la page boîte de dialogue, vous trouverez l'option pour activer et définir un titre de lien pour cette page.

Si vous utilisez Git Sync, le titre du lien de la page est défini dans le SUMMARY.md fichier sur le lien de la page :

circle-info

Remarque : Les titres de lien de page sont utilisés dans la table des matières, les boutons de pagination en bas de chaque page, et dans tous les liens relatifs que vous ajoutez à cette page.

Les titres de lien de page sont optionnels — si vous n'en ajoutez pas manuellement, votre page utilisera par défaut le titre standard de la page.

Groupes de pages

Avec les groupes de pages, vous pouvez regrouper des pages en sections qui couvrent du contenu connexe.

Vous pouvez créer un nouveau groupe de pages en cliquant sur Ajouter un nouveau... > Groupe en bas de votre table des matières.

Les groupes de pages ne peuvent exister qu'au niveau supérieur de la table des matières. Vous ne pouvez pas imbriquer des groupes de pages à l'intérieur d'autres groupes.

Pour changer le titre et le slug d'un groupe de pages, cliquez sur l' menu d’action icône The Actions menu icon in GitBook à côté du titre du groupe dans la table des matières et choisissez Actions de la page.

Vous pouvez aussi ajouter des liens à votre table des matières. En cliquant dessus, les utilisateurs seront dirigés directement vers le contenu lié.

Créez un nouveau lien externe en cliquant sur Ajouter un nouveau... > Lien externe en bas de votre table des matières.

Icônes et emojis de page

Pour améliorer la visibilité pour les lecteurs lorsqu'ils parcourent rapidement votre table des matières, vous pouvez ajouter une icône ou un emoji optionnel aux pages individuelles. L'icône ou l'emoji apparaîtra dans la table des matières et à côté du titre en haut de la page.

Pour ajouter une icône ou un emoji, cliquez sur le Ajouter une icône bouton en survolant le titre de la page, ou le bouton emoji à gauche du titre.

ou en

Dans le ou en menu vous permet de personnaliser l'apparence et la sensation d'une page sélectionnée au sein d'un espace, et de contrôler sa visibilité.

Mise en page

de la page vous permet de faire des choses comme dupliquer, renommer ou supprimer votre page. ou en The Page options menu icon in GitBook menu ou changez la couverture d'une page en survolant le titre de la page. Vous verrez les boutons apparaître juste au-dessus du titre de la page.

Dans le ou en dans le panneau latéral, vous pouvez sélectionner comment chaque page est affichée à ceux qui visitent votre publié contenu. Il existe trois préréglages de mise en page parmi lesquels choisir, ou vous pouvez créer une mise en page personnalisée.

Chaque préréglage de mise en page activera ou désactivera chacune des parties suivantes de la page :

  • Titre de la page

  • Description de la page

  • Table des matières

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

  • Liens précédent/suivant

  • Métadonnées de la page

Vous pouvez aussi définir la largeur globale de votre page depuis ce menu. Choisir Large élargira automatiquement les blocs qui prennent en charge l' Pleine largeur option — tels que les tableaux, les cartes et les blocs de code — pour leur donner plus d'espace lorsque la page est publiée. Ce qui est idéal pour créer des pages d'accueil accrocheuses !

Visibilité

Vous pouvez décider quelles pages vous souhaitez afficher/masquer dans votre documentation publiée, tout en décidant si vous souhaitez que la page soit indexée dans la recherche de votre doc publiée, et/ou indexée par les moteurs de recherche.

Vous pouvez masquer une page ou un groupe de pages de la table des matières de votre site en ouvrant le menu Actions The Actions menu icon in GitBook de la page et en basculant Masquer la page.

Si elle est masquée, ce qui suit apparaîtra dans le front matter du fichier markdown lors de l'utilisation de Git Sync :

Métadonnées (SEO)

Utilisez Options de la page → Métadonnées pour contrôler comment les moteurs de recherche comprennent les relations entre des pages similaires (par exemple : versions de documentation ou des variantes de contenu).

  • URL canonique : l'URL préférée (autoritative) pour cette page.

  • URL alternatives : autres pages qui représentent le même contenu dans une variante différente.

Les deux champs permettent de sélectionner une autre page GitBook (recommandé) ou de saisir une URL externe.

circle-info

Un schéma courant pour les docs versionnées est de définir les pages plus anciennes comme canoniques vers la page équivalente la plus récente (par exemple, 1.02.0), puis de lister les versions plus anciennes comme alternatives sur la page la plus récente.

Covers de page

Vous pouvez également définir une couverture de page pour chaque page de votre documentation. Lorsque vous cliquez sur l' Couverture de la page The Page cover icon in GitBook option, une couverture par défaut sera ajoutée immédiatement. À partir de là, vous pouvez :

  • Changer l'image de couverture

    Survolez la couverture de la page et cliquez sur Changer la couverture, puis sélectionnez ou téléversez une image. En fonction de la manière dont nous affichons actuellement les couvertures de page, 1990x480 pixels est la taille idéale.

  • Repositionner l'image de couverture

    Survolez la couverture de la page et ouvrez le menu Actions The Actions menu icon in GitBook. Cliquez sur Repositionner, puis faites glisser l'image comme vous le souhaitez et cliquez sur Enregistrer.

  • Supprimer l'image de couverture Survolez la couverture de la page et ouvrez le menu Actions The Actions menu icon in GitBook, puis cliquez sur Supprimer.

  • Largeur complète et largeur héros Vous pouvez changer le style de la couverture de votre page pour qu'elle s'étende sur toute la largeur de votre écran ou seulement sur la largeur de votre contenu. Survolez la couverture de la page et ouvrez le menu Actions The Actions menu icon in GitBook, puis choisissez votre option préférée dans le menu.

Mis à jour

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