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 vivent 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 docs 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 la table des matières. La table des matières apparaîtra au même endroit lorsque vous publierez votre espace, sauf si vous choisissez de la masquer.

circle-info

Page d'accueil du site de 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 dans la table des matières.

Créer une nouvelle page

Lorsque vous êtes en édition en direct mode ou dans une demande de modification, vous pouvez créer une nouvelle page en cliquant sur Ajouter nouveau... > Page en bas de votre table des matières. Alternativement, vous pouvez 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 listé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 n'importe quel 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 vos docs.

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 avoir une navigation trop complexe.

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 — sauf si vous avez défini manuellement le slug de la page auparavant.

Vous pouvez modifier le titre, le titre du lien et le slug d'une page à tout moment en ouvrant le menu d'actions The Actions menu icon in GitBook et en choisissant Modifier le titre et le slug.

Titre du lien de la page

Si vous souhaitez que votre page ait un titre SEO plus long tout en conservant un titre plus court pour votre entrée de navigation et vos liens, vous pouvez optionnellement définir un titre de lien.

Ouvrez le menu d'actions The Actions menu icon in GitBook de la page et choisissez Modifier le titre et le slug. Dans la boîte de dialogue Modifier la page , 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 fichier SUMMARY.md 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 facultatifs — 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 rassembler des pages en sections qui couvrent du contenu lié.

Vous pouvez créer un nouveau groupe de pages en cliquant sur Ajouter 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 de pages.

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

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

Créez un nouveau lien externe en cliquant sur Ajouter 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 en parcourant votre table des matières, vous pouvez ajouter une icône ou un emoji optionnel aux pages individuellement. 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.

Options de la page

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

Disposition

Vous pouvez ouvrir le Options de la page The Page options menu icon in GitBook menu ou changer 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 Options de la page panneau latéral, vous pouvez sélectionner comment chaque page est affichée aux personnes qui visitent votre contenu publié . Il existe trois préréglages de disposition au choix, ou vous pouvez créer une disposition personnalisée.

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

  • Titre de la page

  • Description de la page

  • Table des matières

  • Plan de la page

  • Liens précédent/suivant

  • Métadonnées de la page

Vous pouvez également définir la largeur globale de votre page depuis ce menu. Choisir Large élargira automatiquement les blocs qui prennent en charge l' option Pleine largeur — 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é, et/ou indexée par les moteurs de recherche.

Vous pouvez masquer une page ou un groupe de pages dans 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 variantes de contenu).

  • URL canonique : l'URL préférée (autoritaire) pour cette page. Les moteurs de recherche la considèrent comme la « source de vérité ». Utilisez-la lorsque plusieurs URL affichent le même contenu.

  • URLs alternatives : autres URL pour le même contenu dans une autre variante. Par exemple, une autre version ou langue. Elles aident les moteurs de recherche à regrouper les variantes au lieu de les traiter comme des doublons.

Les deux champs prennent en charge la sélection d'une autre page GitBook (recommandé) ou la saisie d'une URL externe.

circle-info

Un schéma courant pour les docs versionnées est de définir les anciennes pages comme canoniques vers la dernière page équivalente (par exemple, 1.02.0), puis de lister les anciennes versions 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' option Couverture de la page The Page cover icon in GitBook , 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échargez une image. En fonction de la façon 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.

  • Pleine largeur 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 juste 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 ?