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

Properties

name
string
required

Name of your project. Used for the global title.

Example: mintlify

navigation
Navigation[]
required

An array of groups with all the pages within that group

logo
string or object

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

favicon
string

Path to the favicon image

colors
Colors

Hex color codes for your global theme

topbarLinks
TopbarLink[]

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

topbarCtaButton
Call to Action
versions
string[]

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

anchors
Anchor[]

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

topAnchor
Object

Override the default configurations for the top-most anchor.

tabs
Tabs[]

An array of navigational tabs.

api
API

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

openapi
string | string[]

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

Examples:

"openapi": "https://example.com/openapi.json"
footerSocials
FooterSocials

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

Example:

{
  "twitter": "https://twitter.com/mintlify",
  "website": "https://mintlify.com"
}
feedback
Feedback

Configurations to enable feedback buttons

modeToggle
ModeToggle

Customize the dark mode toggle.

backgroundImage
string

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

Was this page helpful?