Global Settings

Path to the logo in light mode. For example: /path/to/logo.svg

Path to the logo in dark mode. For example: /path/to/logo.svg

Where clicking on the logo links you to

The primary color. Used most often for highlighted content, section headers, accents, in light mode

The primary color for dark mode. Used most often for highlighted content, section headers, accents, in dark mode

The primary color for important buttons

The color of the background in both light and dark mode

Set if you always want to show light or dark mode for new users. When not set, we default to the same mode as the user’s operating system.

Set to true to hide the dark/light mode toggle. You can combine isHidden with default to force your docs to only use light or dark mode. For example:

"modeToggle": {
  "default": "dark",
  "isHidden": true
}

The name of the group.

The relative paths to the markdown files that will serve as pages. Note: groups are recursive, so to add a sub-folder add another group object in the page array.

The Fontawesome icon for the group. Note: this only applies to sub-folders.

The type of Fontawesome icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin

The name of the button.

The url once you click on the button. Example: https://mintlify.com/contact

Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.

If type is a link: What the button links to.

If type is a github: Link to the repository to load GitHub information from.

Text inside the button. Only required if type is a link.

The Font Awesome icon used to feature the anchor.

Example: comments

The name of the anchor label.

Example: Community

The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in.

The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties from and to that are each a hex color.

Used if you want to hide an anchor until the correct docs version is selected.

Pass true if you want to hide the anchor until you directly link someone to docs inside it.

One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”

The name of the top-most anchor

Font Awesome icon.

One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”

The name of the tab label.

The start of the URL that marks what pages go in the tab. Generally, this is the name of the folder you put your pages in.

Pass true if you want to hide the tab until you directly link someone to docs inside it.

One of the following values website, facebook, x, youtube, discord, slack, github, linkedin, instagram, hacker-news

Example: x

The URL to the social platform.

Example: https://x.com/mintlify

Enables a rating system for users to indicate whether the page has been helpful

Enables a button to allow users to suggest edits via pull requests

Enables a button to allow users to raise an issue about the documentation

Set the prompt for the search bar. Default is Search...

The base url for all API endpoints. If baseUrl is an array, it will enable for multiple base url options that the user can toggle.

Configurations for the API playground

Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.

Enables Intercom widget on docs site. The value should be your Intercom App ID.

Enables Frontchat widget on docs site. The value should be your Frontchat App ID.

The path that you want to redirect from.

Example: /source

The path that you want to redirect to.

Example: /destination

Enables indexing pages not included in navigation.