Structure du site

Organisez votre documentation publiée avec des sections, des variantes et des liens externes

Le contenu de votre site se trouve dans ses sections. Vous pouvez ajouter une ou plusieurs sections. GitBook publiera chacune d’elles et gérera la navigation entre elles.

Types de contenu

Le contenu de votre site peut prendre l’un de deux types de contenu différents, qui déterminent la manière dont GitBook le traite et l’affiche aux visiteurs.

Sections

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

Variantes de contenu

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

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 visiteurs d’ouvrir des sections, des groupes et des liens externes.

Ouvrez l’éditeur de structure depuis Structure du site, sous Général dans la barre latérale du site. Vous pouvez y voir les sections, les variantes et les liens externes de votre site.

Votre site commence avec une seule section portant le nom de votre site et une seule variante contenant le contenu que vous avez créé lors de la configuration de votre site.

La structure d’un site de documentation publié.

Ajouter une section à votre site de documentation

Pour ajouter une section, cliquez sur le bouton Ajouter une section sous le tableau et choisissez le contenu à ajouter. La nouvelle section est ensuite 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 dans la section à laquelle vous souhaitez ajouter du contenu, puis choisissez le contenu à ajouter. La nouvelle variante est ensuite 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 du contenu — sous forme de variante ou de section —, un nom et un slug seront générés à partir de son titre.

Ajout d’un lien externe

Les liens externes ajoutent à la navigation des destinations situées en dehors de votre site. Ajoutez un lien comme élément de navigation à part entière, ou placez-le dans un groupe de section avec des sections associées.

Pour ajouter un lien externe :

1. Dans la barre latérale du site, ouvrez Structure du site.
2. Dans le menu d’ajout, sélectionnez Lien externe.
3. Saisissez le libellé du lien et l’URL de destination.
4. Choisissez si vous souhaitez ajouter le lien séparément ou dans un groupe de section.
5. Cliquez sur Enregistrer.

Le lien apparaît dans la navigation de votre site publié à l’emplacement que vous choisissez.

Modification des sections ou des variantes

Mettez à jour une section ou une variante du site.

Vous pouvez modifier le nom et le slug de chacune de vos sections et variantes en cliquant sur le bouton Modifier 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 enregistrer.

Modifier le slug d’une section modifiera son URL canonique. GitBook créera une redirection automatique de l’ancienne URL vers la nouvelle. Vous pouvez également créer des redirections manuellement.

Les slugs sont uniques dans l’ensemble de votre organisation — chaque chemin ne peut être utilisé que sur un seul site, même entre différents sites. Si vous voyez une erreur indiquant que « le chemin est déjà utilisé », un autre site utilise déjà ce slug. Choisissez un slug légèrement différent, mais toujours pertinent pour votre contenu.

Pour remplacer une section ou une variante, supprimez-la d’abord en cliquant sur son Modifier 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 tableau. Vous pouvez les réorganiser en saisissant la poignée de déplacement et en la déplaçant vers le haut ou vers le bas. L’ordre modifié sera répercuté 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 de nouveau sur la barre d’espace pour confirmer la nouvelle position.

Définition du contenu par défaut

Si votre site comporte plusieurs sections, l’une d’elles 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 ajouté à l’URL racine.

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

Pour définir une section ou une variante comme par défaut, cliquez sur le Menu d’actions dans sa ligne du tableau, puis cliquez sur Définir par défaut.

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

Supprimer du contenu d’un site

Pour supprimer une section ou une variante d’un site, ouvrez l’éditeur de structure depuis Structure du site, sous Général dans la barre latérale du site, puis trouvez le contenu que vous souhaitez supprimer.

Ouvrez le Menu d’actions pour le contenu que vous souhaitez supprimer et choisissez Supprimer.

Supprimer du contenu de votre site le retirera du site publié, mais ne supprimera pas le contenu lui-même — vous pourrez toujours le retrouver dans Tout le contenu.

Si vous supprimez entièrement le contenu d’une section, le site — ainsi que ses paramètres et personnalisations — reste disponible. Le contenu supprimé reste dans la Corbeille pendant sept jours avant d’être supprimé définitivement. Si la section supprimée était la section par défaut de votre site, vérifiez que la section par défaut est toujours correctement définie.