Trillet AI logo

Global Settings

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Every Mintlify site needs a mint.json file with the core configuration settings. Learn more about the properties below.

Properties

namestringrequired

Name of your project. Used for the global title.

Example: mintlify

navigationNavigation[]required

An array of groups with all the pages within that group

logostring or object

Path to logo image or object with path to "light" and "dark" mode logo images

faviconstring

Path to the favicon image

colorsColors

Hex color codes for your global theme

topbarLinksTopbarLink[]

Array of names and urls of links you want to include in the topbar

topbarCtaButtonCall to Action
versionsstring[]

Array of version names. Only use this if you want to show different versions of docs with a dropdown in the navigation bar.

anchorsAnchor[]

An array of the anchors, includes the icon, color, and url.

topAnchorObject

Override the default configurations for the top-most anchor.

tabsTabs[]

An array of navigational tabs.

apiAPI

Configuration for API settings. Learn more about API pages at API Components.

openapistring | string[]

A string or an array of strings of URL(s) or relative path(s) pointing to your OpenAPI file.

Examples:

Absolute
"openapi": "https://example.com/openapi.json"
Relative
"openapi": "/openapi.json"
Multiple
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
footerSocialsFooterSocials

An object of social media accounts where the key:property pair represents the social media platform and the account url.

Example:

{
  "x": "https://x.com/mintlify",
  "website": "https://mintlify.com"
}
feedbackFeedback

Configurations to enable feedback buttons

modeToggleModeToggle

Customize the dark mode toggle.

backgroundImagestring

A background image to be displayed behind every page. See example with Infisical and FRPC.