Variantes de contenu

Publiez la documentation pour plusieurs versions de produit ou langues sur un seul site

Vous pouvez publier plusieurs versions de la même documentation dans le cadre d’un seul site de documentation. Ces variantes seront disponibles pour les utilisateurs finaux via le sélecteur d’espaces dans le coin supérieur 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 des variations du 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.

Lors de l’ajout d’une traduction ou de plusieurs langues comme variante, il est recommandé de définir la langue de votre variante afin d’offrir à vos utilisateurs la meilleure expérience possible lors de la navigation dans votre documentation.

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

Ajouter une variante à votre site de documentation

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. Vous pouvez ici voir tout le contenu de votre site.

Pour ajouter une variante, cliquez sur le bouton Ajouter une variante 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.

Modifier une variante

Vous pouvez modifier le nom et le slug de chacune de vos variantes en cliquant sur le bouton Modifier dans la ligne du tableau de la variante 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. Vous pouvez également supprimer la variante en cliquant sur le bouton Supprimer la variante en bas à gauche.

Si votre site prend en charge plusieurs langues, vous pouvez également traduire les titres des variantes afin que le sélecteur affiche des libellés localisés. Voir Sections multilingues.

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 également créer des redirections manuellement.

Pour remplacer l’espace lié d’une variante par un autre espace, supprimez d’abord cette 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éorganiser les variantes

Votre site affiche les variantes dans l’ordre dans lequel elles apparaissent dans votre Structure du site tableau. Les variantes peuvent être réorganisées en saisissant la poignée de glissement 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 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éfinir une variante par défaut

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

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

Définir une variante comme par défaut supprime son champ 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 s’assurer 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 documentation, puis cliquez sur Structure pour trouver le contenu que vous souhaitez supprimer.

Ouvrez le menu d’actions pour la variante que vous souhaitez supprimer et choisissez Supprimer.

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