Pages associées
Affichez une section Sujets associés en bas de chaque page, avec des suggestions automatiques ou des liens sélectionnés manuellement dans le frontmatter.
Les pages associées font apparaître une section Sujets associés en bas de chaque page de documentation, aidant les lecteurs à découvrir du contenu connexe. Les suggestions peuvent provenir de recommandations basées sur la recherche, de liens que vous sélectionnez dans le frontmatter de la page, ou d’un mélange des deux.
Les pages associées sont un module complémentaire de déploiement. Activez-le dans votre tableau de bord :
- Ouvrez votre tableau de bord et accédez à Paramètres > Modules complémentaires.
- Trouvez Sujets associés et activez l’option.
- Sélectionnez un mode et, éventuellement, définissez une limite du nombre de pages affichées.
AutomaticmodeLes suggestions sont générées à partir de l’index de recherche de votre documentation en utilisant le titre de la page en cours. Les remplacements via le frontmatter restent prioritaires lorsqu’ils sont définis. Utilisez ce mode lorsque vous souhaitez que les pages associées se mettent à jour automatiquement à mesure que vous ajoutez du contenu.
ManualmodeSeules les pages listées dans le champ related du frontmatter d’une page sont affichées. Les pages sans champ related n’affichent aucune section Sujets associés. Utilisez ce mode lorsque vous souhaitez un contrôle éditorial complet.
Définissez le nombre de pages associées à afficher. La valeur par défaut est 5 et la valeur maximale est 10. La limite s’applique aux suggestions automatiques ; les entrées manuelles sont plafonnées à la valeur maximale.
Utilisez le champ de frontmatter related pour remplacer ou fournir la liste des pages associées pour une seule page. Cela fonctionne à la fois en mode Automatic et en mode Manual.
relatedarray | falseUne liste de pages associées, ou false pour masquer la section Sujets associés sur cette page.
Chaque entrée peut être :
- Un chemin relatif à la racine vers une autre page de votre documentation :
/api-playground/overview - Une URL absolue vers un site externe :
https://example.com/docs - Un objet
Title: linkpour définir un libellé explicite
Les titres et icônes des chemins internes sont déduits de votre navigation lorsqu’ils ne sont pas définis explicitement. Les liens externes s’ouvrent dans un nouvel onglet.
Sélectionnez une liste de pages internes :
---
title: "Authentication"
related:
- /api-playground/overview
- /deploy/authentication-setup
- /organize/hidden-pages
---Mélangez pages internes, liens externes et titres personnalisés :
---
title: "Authentication"
related:
- Overview: /api-playground/overview
- Set up auth: /deploy/authentication-setup
- OAuth 2.0 spec: https://oauth.net/2/
---Masquez la section Sujets associés sur une page spécifique :
---
title: "Changelog"
related: false
---En mode Automatic, les pages associées sont générées à partir de l’index de recherche de votre documentation en utilisant le titre de la page en cours comme requête. Les résultats sont filtrés selon la langue et la version de la page, le cas échéant, et la page en cours est exclue.
Pour les déploiements avec authentification des utilisateurs finaux, les suggestions automatiques sont désactivées afin d’éviter les fuites de contenu entre contextes utilisateur. Utilisez le champ de frontmatter related pour afficher des suggestions sélectionnées sur les déploiements avec authentification utilisateur.
- Pages : Configurez les métadonnées de page avec le frontmatter.
- Création de liens : Bonnes pratiques pour relier les pages entre elles.
- Recherche : Configurez la façon dont les résultats de recherche sont classés et filtrés.