Variantes de contenu

Publiez une documentation pour plusieurs versions de produit ou langues sur un même site

Vous pouvez publier plusieurs versions d’une même documentation dans le cadre d’un même site de docs. Ces variantes seront disponibles pour les utilisateurs finaux via le sélecteur d’espace en haut à gauche du site publié.

Ajouter plusieurs langues ou versions

Un site avec plusieurs variantes est utile si vous devez regrouper le contenu de vos espaces — par exemple si vous documentez plusieurs versions d’une API (v1, v2, v3, etc.) ou si vous documentez votre contenu dans différentes langues.

Les espaces que vous liez peuvent contenir n’importe quel contenu, mais il est recommandé d’utiliser les variantes comme variations d’un même contenu. Si les espaces que vous liez sont sémantiquement différents les uns des autres, envisagez de les ajouter comme sections du site à la place.

Lorsque vous ajoutez une traduction ou plusieurs langues en tant que variante, il est recommandé de définir la langue de votre variante afin d’offrir la meilleure expérience à vos utilisateurs lors de la navigation dans votre documentation.

L’ajout de plusieurs variantes avec les langues définies déplacera le sélecteur de langue en haut à droite, offrant une expérience plus épurée et plus directe par rapport au sélecteur de variante par défaut.

Ajout d’une variante à votre site de docs

Depuis le tableau de bord de votre site de docs, 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.

Pour ajouter une 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 au sein de la section choisie et sera disponible pour les visiteurs dans le menu déroulant des variantes de votre site.

Modification d’une variante

Vous pouvez modifier le nom et le slug de chacune de vos variantes en cliquant sur le Modifier bouton dans la ligne du tableau de la variante que vous souhaitez modifier. Cela ouvrira une fenêtre modale. Modifiez le(s) champ(s) que vous souhaitez changer, puis cliquez sur le Enregistrer bouton pour sauvegarder. Vous pouvez également supprimer la variante en cliquant sur le Supprimer la variante bouton en bas à gauche.

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 l’espace lié d’une variante par un autre espace, supprimez d’abord la variante en cliquant sur son Modifier bouton, puis cliquez sur le Supprimer bouton en bas à gauche de la fenêtre modale. Une fois la variante supprimée, cliquez sur le Ajouter une variante bouton pour ajouter le nouvel espace.

Réorganisation des variantes

Votre site affiche les variantes dans l’ordre où elles apparaissent dans votre Structure du site tableau. Les variantes peuvent être réordonnées en saisissant la Poignée de glisser et en la déplaçant vers le haut ou vers le bas. L’ordre modifié sera immédiatement reflété sur votre site.

Vous pouvez également utiliser le clavier pour sélectionner et déplacer le 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éfinir une variante par défaut

Si vous avez plusieurs variantes au sein d’une section, une variante sera marquée comme étant par défaut. Cette variante 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 du site.

Pour définir une variante comme par défaut, cliquez sur le menu Actions dans la ligne du tableau de la variante puis cliquez sur Définir par défaut.

Définir une variante comme par défaut supprime son champ de slug, car elle sera servie depuis la racine de la section à la place. GitBook redirigera le slug de la variante vers le chemin approprié, afin de garantir que les visiteurs continuent de voir votre contenu.

Supprimer une variante d’un site

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

Ouvrez le menu Actions pour la variante que vous souhaitez supprimer et choisissez Supprimer.

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