Enable related topics
- Navigate to the Add-ons page in your dashboard.
- In the “Related topics” section, enable Show related topics.
- Choose a mode and, optionally, set a limit on how many pages are shown.
Modes
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.
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.Limit
Set how many related pages to display. The default is5 and the maximum is 10.
Configure per page with frontmatter
Use therelated frontmatter field to override or supply the list of related pages for a single page. This works in both Automatic and Manual modes.
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: linkobject to set an explicit label
Examples
Curate a list of internal pages: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 therelated frontmatter field to show curated suggestions on user-authenticated deployments.
Troubleshooting
If the Related topics section doesn’t appear on a page, check the following:- Show related topics is enabled on the Add-ons page.
- The page’s frontmatter does not set
related: false. - In Manual mode, the page has a
relatedfield with at least one entry. Pages withoutrelatedshow no section in Manual mode. - The deployment does not use end-user authentication, which disables automatic suggestions.
- In Automatic mode, the page has a
titlefor the search index to match against.