Páginas relacionadas
Muestra una sección de Temas relacionados al final de cada página con sugerencias automáticas o enlaces seleccionados manualmente desde el frontmatter.
Las páginas relacionadas muestran una sección de Temas relacionados en la parte inferior de cada página de documentación, ayudando a los lectores a descubrir contenido conectado. Las sugerencias pueden provenir de recomendaciones basadas en búsqueda, de enlaces que seleccionas en el frontmatter de la página o de una combinación de ambos.
Las páginas relacionadas son un add-on de la implementación. Habilítalo en tu panel:
- Abre tu panel y ve a Configuración > Add-ons.
- Encuentra Temas relacionados y actívalo.
- Selecciona un modo y, opcionalmente, establece un límite en cuántas páginas se muestran.
AutomaticmodeLas sugerencias se generan a partir del índice de búsqueda de tus documentos usando el título de la página actual. Las anulaciones en el frontmatter siguen teniendo prioridad cuando se configuran. Usa este modo cuando quieras que las páginas relacionadas se actualicen automáticamente a medida que agregas contenido.
ManualmodeSolo se muestran las páginas listadas en el frontmatter related de una página. Las páginas sin un campo related no muestran ninguna sección de Temas relacionados. Usa este modo cuando quieras control editorial total.
Establece cuántas páginas relacionadas mostrar. El valor predeterminado es 5 y el máximo es 10. El límite se aplica a las sugerencias automáticas; las entradas manuales están limitadas al máximo.
Usa el campo de frontmatter related para anular o proporcionar la lista de páginas relacionadas para una sola página. Esto funciona tanto en el modo Automático como en el Manual.
relatedarray | falseUna lista de páginas relacionadas, o false para ocultar la sección Temas relacionados en esta página.
Cada entrada puede ser:
- Una ruta relativa a la raíz de otra página en tus documentos:
/api-playground/overview - Una URL absoluta a un sitio externo:
https://example.com/docs - Un objeto
Title: linkpara establecer una etiqueta explícita
Los títulos e íconos para las rutas internas se infieren de tu navegación cuando no se establecen explícitamente. Los enlaces externos se abren en una nueva pestaña.
Selecciona una lista de páginas internas:
---
title: "Authentication"
related:
- /api-playground/overview
- /deploy/authentication-setup
- /organize/hidden-pages
---Combina páginas internas, enlaces externos y títulos personalizados:
---
title: "Authentication"
related:
- Overview: /api-playground/overview
- Set up auth: /deploy/authentication-setup
- OAuth 2.0 spec: https://oauth.net/2/
---Oculta la sección Temas relacionados en una página específica:
---
title: "Changelog"
related: false
---En el modo Automático, las páginas relacionadas se generan a partir del índice de búsqueda de tus documentos usando el título de la página actual como consulta. Los resultados se filtran por el idioma y la versión de la página cuando corresponde, y la página actual se excluye.
Para las implementaciones con autenticación de usuario final, las sugerencias automáticas están deshabilitadas para evitar filtrar contenido entre contextos de usuario. Usa el campo de frontmatter related para mostrar sugerencias seleccionadas en implementaciones autenticadas por usuario.