Related topics
Add a related topics section at the bottom of each page using automatic recommendations or manually curated links defined in page 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
- Navigate to the Add-ons page in your dashboard.
- In the “Related topics” section, enable Show related topics.
- Select a mode and, optionally, set a limit on how many pages to show.
Modes
AutomaticmodeMintlify 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.
ManualmodeOnly 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.
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.
relatedarray | falseA 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: linkobject 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.
Examples
Curate a list of internal pages:
---
title: "Authentication"
related:
- /api-playground/overview
- /deploy/authentication-setup
- /organize/hidden-pages
---Mix internal pages, external links, and custom titles:
---
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:
---
title: "Changelog"
related: false
---How suggestions 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.
For deployments with end-user authentication, automatic suggestions are disabled to avoid leaking content across user contexts. Use the related frontmatter field to show curated suggestions on user-authenticated deployments.