Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
"organize/navigation",
"organize/pages",
"organize/hidden-pages",
"organize/related-pages",
"organize/mintignore"
]
},
Expand Down
1 change: 1 addition & 0 deletions es.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"es/organize/navigation",
"es/organize/pages",
"es/organize/hidden-pages",
"es/organize/related-pages",
"es/organize/mintignore"
]
},
Expand Down
4 changes: 4 additions & 0 deletions es/organize/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ Usa el frontmatter para controlar:
Establécelo en `true` para ocultar los enlaces de navegación de página anterior/siguiente en la parte inferior de la página. Úsalo para páginas independientes como páginas de destino o páginas de referencia donde la navegación secuencial no aplica.
</ResponseField>

<ResponseField name="related" type="array or boolean">
Una lista de páginas relacionadas para mostrar en la sección **Temas relacionados** en la parte inferior de la página, o `false` para ocultar la sección por completo. Anula las sugerencias automáticas de la implementación. Requiere que el add-on [Páginas relacionadas](/es/organize/related-pages) esté habilitado. Consulta [Páginas relacionadas](/es/organize/related-pages) para más detalles.
</ResponseField>

<ResponseField name="hideApiMarker" type="boolean">
Establécelo en `true` para ocultar la insignia del método HTTP (como GET o POST) junto al título de la página en la barra lateral. Úsalo para páginas de API donde desees una apariencia más limpia en la barra lateral.
</ResponseField>
Expand Down
105 changes: 105 additions & 0 deletions es/organize/related-pages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
title: "Páginas relacionadas"
description: "Muestra una sección de Temas relacionados en la parte inferior de cada página con sugerencias automáticas basadas en búsqueda o enlaces seleccionados manualmente desde el frontmatter."
keywords: ["relacionadas", "páginas relacionadas", "temas relacionados", "recomendaciones", "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.

<div id="enable-related-pages">
## Habilitar páginas relacionadas
</div>

Las páginas relacionadas son un add-on de la implementación. Habilítalo en tu panel:

1. Abre tu panel y ve a **Configuración** > **Add-ons**.
2. Encuentra **Temas relacionados** y actívalo.
3. Elige un modo y, opcionalmente, establece un límite en cuántas páginas se muestran.

<div id="modes">
## Modos
</div>

<ResponseField name="Automatic" type="mode">
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.
</ResponseField>

<ResponseField name="Manual" type="mode">
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.
</ResponseField>

<div id="limit">
### Límite
</div>

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.

<div id="configure-per-page-with-frontmatter">
## Configurar por página con frontmatter
</div>

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**.

<ResponseField name="related" type="array | false">
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.
</ResponseField>

<div id="examples">
### Ejemplos
</div>

Selecciona una lista de páginas internas:

```mdx
---
title: "Authentication"
related:
- /api-playground/overview
- /deploy/authentication-setup
- /organize/hidden-pages
---
```

Combina páginas internas, enlaces externos y títulos personalizados:

```mdx
---
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:

```mdx
---
title: "Changelog"
related: false
---
```

<div id="how-suggestions-are-generated">
## Cómo se generan las sugerencias
</div>

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](/es/deploy/authentication-setup), 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.

<div id="related-resources">
## Recursos relacionados
</div>

- [Páginas](/es/organize/pages): Configura los metadatos de la página con frontmatter.
- [Enlaces](/es/guides/linking): Mejores prácticas para conectar páginas entre sí.
- [Búsqueda](/es/optimize/search): Configura cómo se clasifican y filtran los resultados de búsqueda.
1 change: 1 addition & 0 deletions fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"fr/organize/navigation",
"fr/organize/pages",
"fr/organize/hidden-pages",
"fr/organize/related-pages",
"fr/organize/mintignore"
]
},
Expand Down
4 changes: 4 additions & 0 deletions fr/organize/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ Utilisez le frontmatter pour contrôler :
Définir sur `true` pour masquer les liens de navigation page précédente/page suivante en bas de la page. Utilisez cette option pour les pages autonomes telles que les pages de destination ou les pages de référence où la navigation séquentielle ne s'applique pas.
</ResponseField>

<ResponseField name="related" type="array or boolean">
Une liste de pages associées à afficher dans la section **Sujets associés** en bas de la page, ou `false` pour masquer entièrement la section. Remplace les suggestions automatiques du déploiement. Nécessite l'activation du module complémentaire [Pages associées](/fr/organize/related-pages). Voir [Pages associées](/fr/organize/related-pages) pour plus de détails.
</ResponseField>

<ResponseField name="hideApiMarker" type="boolean">
Définir sur `true` pour masquer le badge de méthode HTTP (tel que GET ou POST) à côté du titre de la page dans la barre latérale. Utilisez cette option pour les pages d'API lorsque vous souhaitez une apparence plus épurée de la barre latérale.
</ResponseField>
Expand Down
105 changes: 105 additions & 0 deletions fr/organize/related-pages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
title: "Pages associées"
description: "Affichez une section Sujets associés en bas de chaque page avec des suggestions automatiques basées sur la recherche ou des liens sélectionnés manuellement depuis le frontmatter."
keywords: ["associées", "pages associées", "sujets associés", "recommandations", "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.

<div id="enable-related-pages">
## Activer les pages associées
</div>

Les pages associées sont un module complémentaire de déploiement. Activez-le dans votre tableau de bord :

1. Ouvrez votre tableau de bord et accédez à **Paramètres** > **Modules complémentaires**.
2. Trouvez **Sujets associés** et activez l'option.
3. Choisissez un mode et, éventuellement, définissez une limite du nombre de pages affichées.

<div id="modes">
## Modes
</div>

<ResponseField name="Automatic" type="mode">
Les 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.
</ResponseField>

<ResponseField name="Manual" type="mode">
Seules 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.
</ResponseField>

<div id="limit">
### Limite
</div>

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.

<div id="configure-per-page-with-frontmatter">
## Configurer par page avec le frontmatter
</div>

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**.

<ResponseField name="related" type="array | false">
Une 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: link` pour 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.
</ResponseField>

<div id="examples">
### Exemples
</div>

Sélectionnez une liste de pages internes :

```mdx
---
title: "Authentication"
related:
- /api-playground/overview
- /deploy/authentication-setup
- /organize/hidden-pages
---
```

Mélangez pages internes, liens externes et titres personnalisés :

```mdx
---
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 :

```mdx
---
title: "Changelog"
related: false
---
```

<div id="how-suggestions-are-generated">
## Comment les suggestions sont générées
</div>

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](/fr/deploy/authentication-setup), 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.

<div id="related-resources">
## Ressources associées
</div>

- [Pages](/fr/organize/pages) : Configurez les métadonnées de page avec le frontmatter.
- [Création de liens](/fr/guides/linking) : Bonnes pratiques pour relier les pages entre elles.
- [Recherche](/fr/optimize/search) : Configurez la façon dont les résultats de recherche sont classés et filtrés.
4 changes: 4 additions & 0 deletions organize/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ Use frontmatter to control:
Set to `true` to hide the previous/next page navigation links at the bottom of the page. Use this for standalone pages like landing pages or reference pages where sequential navigation does not apply.
</ResponseField>

<ResponseField name="related" type="array or boolean">
A list of related pages to show in the **Related topics** section at the bottom of the page, or `false` to hide the section entirely. Overrides the deployment's automatic suggestions. Requires enabling the [Related pages](/organize/related-pages) add-on.
</ResponseField>

<ResponseField name="hideApiMarker" type="boolean">
Set to `true` to hide the HTTP method badge (such as GET or POST) next to the page title in the sidebar. Use this for API pages where you want a cleaner sidebar appearance.
</ResponseField>
Expand Down
84 changes: 84 additions & 0 deletions organize/related-pages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: "Related topics"
description: "Add links to related pages at the bottom of each page with automatic suggestions or manually curated links from frontmatter."
keywords: ["related", "related pages", "related topics", "recommendations", "frontmatter"]
---

Add related topics to the bottom of each page to help readers discover relevant content. Suggested pages can come from automated recommendations, from links you curate in page frontmatter, or from a mix of both.

## Enable related topics

1. Navigate to the [Add-ons](https://app.mintlify.com/settings/deployment/addons) page in your dashboard.
2. In the "Related topics" section, enable **Show related topics**.
3. Choose a mode and, optionally, set a limit on how many pages are shown.

Check warning on line 13 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L13

In general, use active voice instead of passive voice ('are shown').

## Modes

<ResponseField name="Automatic" type="mode">
Mintlify generates suggestions from your contents' search index using the current page's title. Frontmatter overrides still take precedence over automatic suggestions. Use this mode when you want related pages to update automatically as you add content.
</ResponseField>

<ResponseField name="Manual" type="mode">
Only pages listed in a page's `related` frontmatter are shown. Pages without a `related` field display no **Related topics** section. Use this mode when you want full editorial control.

Check warning on line 22 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L22

In general, use active voice instead of passive voice ('are shown').
Comment thread
ethanpalm marked this conversation as resolved.
</ResponseField>

### Limit

Set how many related pages to display. The default is `5` and the maximum is `10`.

## Configure per page with frontmatter

Use the `related` frontmatter field to override or supply the list of related pages for a single page. This works in both **Automatic** and **Manual** modes.

<ResponseField name="related" type="array | false">
A list of related pages, or `false` to hide the **Related topics** section on this page.

Each entry can be:
- A root-relative path to another page in your docs: `/api-playground/overview`
- An absolute URL to an external site: `https://example.com/docs`
- A `Title: link` object to set an explicit label

If you don't explicitly set titles and icons for internal paths, Mintlify infers them. External links open in a new tab.
</ResponseField>

### Examples

Curate a list of internal pages:

```mdx
---
title: "Authentication"
related:
- /api-playground/overview
- /deploy/authentication-setup
- /organize/hidden-pages
---
```

Mix internal pages, external links, and custom titles:

```mdx
---
title: "Authentication"
related:
- Overview: /api-playground/overview
- Set up auth: /deploy/authentication-setup
- OAuth 2.0 spec: https://oauth.net/2/
---
```

Hide the **Related topics** section on a specific page:

```mdx
---
title: "Changelog"
related: false
---
```

## How suggestions are generated

Check warning on line 79 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L79

In general, use active voice instead of passive voice ('are generated').

In **Automatic** mode, related pages are generated from your docs' search index using the current page's title as the query. Results are filtered by the page's language and version when applicable, and the current page is excluded.

Check warning on line 81 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L81

In general, use active voice instead of passive voice ('are generated').

Check warning on line 81 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L81

In general, use active voice instead of passive voice ('are filtered').

Check warning on line 81 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L81

In general, use active voice instead of passive voice ('is excluded').

For deployments with [end-user authentication](/deploy/authentication-setup), automatic suggestions are disabled to avoid leaking content across user contexts. Use the `related` frontmatter field to show curated suggestions on user-authenticated deployments.

Check warning on line 83 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L83

In general, use active voice instead of passive voice ('are disabled').

1 change: 1 addition & 0 deletions zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"zh/organize/navigation",
"zh/organize/pages",
"zh/organize/hidden-pages",
"zh/organize/related-pages",
"zh/organize/mintignore"
]
},
Expand Down
4 changes: 4 additions & 0 deletions zh/organize/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ boost: 3
设为 `true` 可隐藏页面底部的上一页/下一页导航链接。适用于落地页或参考页等不需要顺序导航的独立页面。
</ResponseField>

<ResponseField name="related" type="array or boolean">
要在页面底部 **相关主题** 部分显示的相关页面列表,或设为 `false` 以完全隐藏该部分。此字段会覆盖部署的自动推荐。需要启用 [相关页面](/zh/organize/related-pages) add-on。详情参见 [相关页面](/zh/organize/related-pages)。
</ResponseField>

<ResponseField name="hideApiMarker" type="boolean">
设为 `true` 可隐藏侧边栏中页面标题旁的 HTTP 方法标记(如 GET 或 POST)。适用于希望侧边栏外观更简洁的 API 页面。
</ResponseField>
Expand Down
Loading
Loading