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, links you curate in page frontmatter, or both.

Navigate to the General 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

Automaticmode

Mintlify generates suggestions from your content’s 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.

Manualmode

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

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, Mintlify generates related pages from your docs’ search index using the current page’s title as the query. It filters results by the page’s language and version when applicable, and excludes the current page.

For deployments with end-user authentication, Mintlify loads automatic suggestions after a reader signs in, using that reader’s own authenticated search results. Related pages only include pages the reader has permission to view. For more control in an authenticated deployment, use the related frontmatter field to curate suggestions.

Enable related topics

Modes

Limit

Configure per page with frontmatter

Examples

How suggestions are generated

On this page