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.
Habilitar páginas relacionadas
- Abre tu panel y ve a Configuración > Add-ons.
- Encuentra Temas relacionados y actívalo.
- Elige un modo y, opcionalmente, establece un límite en cuántas páginas se muestran.
Las 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.
Solo 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.
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.
Configurar por página con 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.
Una 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: link para 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. ---
title: "Authentication"
related:
- /api-playground/overview
- /deploy/authentication-setup
- /organize/hidden-pages
---
---
title: "Authentication"
related:
- Overview: /api-playground/overview
- Set up auth: /deploy/authentication-setup
- OAuth 2.0 spec: https://oauth.net/2/
---
---
title: "Changelog"
related: false
---
Cómo se generan las sugerencias
related para mostrar sugerencias seleccionadas en implementaciones autenticadas por usuario.
- Páginas: Configura los metadatos de la página con frontmatter.
- Enlaces: Mejores prácticas para conectar páginas entre sí.
- Búsqueda: Configura cómo se clasifican y filtran los resultados de búsqueda.
