Structure du site

Ajoutez de la structure à votre documentation publiée en utilisant des sections de site et des variantes

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

Types de contenu

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

Variantes de contenu

Publiez plusieurs versions du même contenu — idéal pour la localisation, la gestion des versions, et plus encore.

Sections du site

Divisez votre site en parties distinctes — idéal pour plusieurs produits ou parties de votre organisation.

Gestion de la structure de votre site

En gérant la structure de votre site, vous pouvez également gérer la barre de navigation principale de votre site. Cette barre de navigation permet aux utilisateurs de passer à différentes sections du site et groupes de sections.

Depuis le tableau de bord de votre site de documentation, ouvrez le Paramètres onglet dans l'en-tête du site, puis cliquez sur Structure. Ici vous pouvez voir tout le contenu de votre site, divisé en sections et 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.

La structure d'un site de documentation publié.

Lier un espace à votre site de documentation

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

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

Lorsque vous ajoutez un espace — comme variante ou comme section — un nom et un slug seront générés en fonction du titre de l'espace.

Modifier les sections ou les variantes

Mettre à jour une section ou une variante du site.

Vous pouvez modifier le nom et le slug de chaque section et variante en cliquant sur le Modifier bouton dans la ligne du tableau de l'élément que vous souhaitez éditer. Cela ouvrira une fenêtre modale. Modifiez le(s) champ(s) que vous souhaitez changer, puis cliquez sur le Enregistrer bouton pour sauvegarder.

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

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

Réorganiser les sections ou les variantes

Votre site affiche les sections et variantes dans l'ordre où elles apparaissent dans votre Structure du site tableau. Elles peuvent être réordonnées en saisissant la Poignée de glissement et en la déplaçant vers le haut ou 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éfinir le contenu par défaut

Si vous avez plusieurs sections sur votre site, une section sera marquée comme Par défaut. Cette section est affichée 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 par défaut. Comme pour les sections, la variante par défaut est affichée 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 par défaut, cliquez sur le menu Actions dans la ligne du tableau de l'espace puis cliquez sur Définir par défaut.

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

Supprimer du contenu d'un site

Pour supprimer 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 Actions pour l'espace que vous souhaitez supprimer et choisissez Supprimer.

La suppression d'un espace de votre site le retirera du site publié, mais ne supprimera pas l'espace ni le contenu qu'il contient.