window-restoreStructure du site

Ajoutez de la structure à votre documentation publiée à l’aide de sections de site et de variantes

Le contenu de votre site provient de espaces dans votre organisation. Vous pouvez lier un ou plusieurs espaces. GitBook publiera chacun d’entre eux et gérera la navigation entre les espaces.

Types de contenu

Les espaces liés peuvent servir de l’un de deux types de contenu différents, qui déterminent comment GitBook les traite les uns par rapport aux autres et les affiche aux visiteurs.

Gestion de la structure de votre site

En gérant la structure de votre site, vous pouvez également gérer la barre de navigation supérieure de votre site. Cette barre de navigation permet aux utilisateurs d’accéder à différentes sections du site et à des groupes de sections du site.

Depuis le tableau de bord de votre site de documentation, ouvrez l’onglet Paramètres dans l’en-tête du site, puis cliquez sur Structure. Ici, vous pouvez voir tout le contenu de votre site, réparti en sections et en variantes.

Votre site commence avec une seule section portant le nom de votre site et une seule variante avec l’espace que vous avez lié lors de la configuration de votre site.

A GitBook screenshot showing a docs site's structure
La structure d’un site de documentation publié.

Lier un espace à votre site de documentation

Pour ajouter une section du site, cliquez sur le bouton Ajouter une section sous le tableau et choisissez un espace à lier comme section. La nouvelle section est alors ajoutée au tableau et sera disponible pour les visiteurs sous forme d’onglet en haut de votre site.

Pour ajouter une variante, cliquez sur le bouton Ajouter une variante bouton dans la section à laquelle vous souhaitez l’ajouter, puis choisissez un espace à lier. La nouvelle variante est alors ajoutée à la liste des variantes dans la section choisie et sera disponible pour les visiteurs dans le menu déroulant des variantes sur votre site.

Lorsque vous ajoutez un espace — en tant que variante ou section — un nom et un slug seront générés à partir du titre de l’espace.

Modification des sections ou des variantes

A GitBook screenshot showing how to edit a variant
Mettez à jour une section ou une variante du site.

Vous pouvez modifier le nom et le slug de chacune des sections et variantes en cliquant sur le bouton Modifier The Edit icon in GitBook dans la ligne du tableau de l’élément que vous souhaitez modifier. Cela ouvrira une fenêtre modale. Modifiez le ou les champs que vous souhaitez changer, puis cliquez sur le bouton Enregistrer pour sauvegarder.

circle-info

La modification du slug d’un espace lié modifiera l’URL canonique de l’espace. GitBook créera une redirection automatique de l’ancienne URL vers la nouvelle. Vous pouvez également créer des redirections manuellement.

Pour remplacer une section ou une variante, supprimez-la d’abord en cliquant sur son Modifier The Edit icon in GitBook bouton, puis cliquez sur le bouton Supprimer en bas à gauche de la fenêtre modale. Une fois l’élément supprimé, cliquez sur le bouton Ajouter une section ou Ajouter une variante pour l’ajouter à nouveau.

Réorganisation des sections ou des variantes

Votre site affiche les sections et les variantes dans l’ordre dans lequel elles apparaissent dans votre Structure du site . Elles peuvent être réorganisées en saisissant la poignée de déplacement The Options menu icon in GitBook et en la déplaçant vers le haut ou vers le bas. L’ordre modifié sera reflété immédiatement sur votre site.

Vous pouvez également utiliser le clavier pour sélectionner et déplacer du contenu. Sélectionnez une section ou une variante avec la barre d’espace, puis utilisez les touches fléchées pour la déplacer vers le haut ou vers le bas. Appuyez à nouveau sur la barre d’espace pour confirmer la nouvelle position.

Définition du contenu par défaut

Si votre site comporte plusieurs sections, une section sera marquée comme Par défaut. Cette section s’affiche lorsque les visiteurs arrivent sur votre site, et est servie depuis l’URL racine de votre site. Les autres sections ont chacune un slug qui est ajouté à l’URL racine.

Si vous avez plusieurs variantes au sein d’une section, une variante sera marquée comme étant la valeur par défaut. Comme pour les sections, la variante par défaut s’affiche lorsque les visiteurs arrivent sur votre site, ou lorsqu’ils visitent une section. Les autres variantes ont chacune un slug qui est ajouté à l’URL de la section.

Pour définir un espace comme valeur par défaut, cliquez sur le menu d’actions The Actions menu icon in GitBook dans la ligne du tableau de l’espace, puis cliquez sur Définir comme valeur par défaut.

circle-info

Définir un espace comme valeur par défaut supprime son champ slug, car il sera servi à partir de la racine de la section à la place. GitBook redirige le slug de l’espace vers le chemin approprié, afin de s’assurer que les visiteurs continuent de voir votre contenu.

Supprimer du contenu d’un site

Pour retirer le contenu d’un espace d’un site, ouvrez l’onglet Paramètres depuis le tableau de bord de votre site de documentation, puis cliquez sur Structure pour trouver le contenu que vous souhaitez supprimer.

Ouvrez le menu d’actions The Actions menu icon in GitBook de l’espace que vous souhaitez supprimer et choisissez Supprimer.

circle-check

Mis à jour

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