Global Settings (mint.json)

Every Mintlify site needs a mint.json file with the core configuration settings. Learn more about the properties or from an example

Properties

nameRequired

string

Name of your project. Used for the global title.

Example: mintlify

navigationRequired

Navigation[]

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.

api

API

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

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"
}

hideFeedbackButtonsDefault: false

boolean

Whether or not to hide the edit suggestion and raise and issue buttons at the top of every page. Defaults to false

modeToggle

ModeToggle

Customize the dark mode toggle.

default

"light" or "dark"

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.

isHiddenDefault: false

boolean

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
}

backgroundImage

string

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

Example `mint.json`

Click on the following dropdown to view a sample configuration file

Example mint.json

{
  "name": "Mintlify",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  },
  "favicon": "/favicon.svg",
  "colors": {
    "primary": "#16A34A",
    "light": "#4ADE80",
    "dark": "#166534"
  },
  "topbarLinks": [
    {
      "name": "Contact Us",
      "url": "mailto:[email protected]"
    }
  ],
  "topbarCtaButton": {
    "name": "Get Started",
    "url": "https://1tc7vihvbit.typeform.com/to/pZJ31XZB"
  },
  "anchors": [
    {
      "name": "API Components",
      "icon": "rectangle-terminal",
      "color": "#f59f0b",
      "url": "api-components"
    },
    {
      "name": "Community",
      "icon": "comments",
      "color": "#2564eb",
      "url": "https://discord.gg/MPNgtSZkgK"
    }
  ],
  "navigation": [
    {
      "group": "Getting Started",
      "pages": ["introduction", "quickstart"]
    },
    {
      "group": "API Components",
      "pages": ["api-components/playground", "api-components/examples"]
    },
    {
      "group": "Settings",
      "pages": ["settings/global", "settings/page"]
    },
    {
      "group": "Analytics",
      "pages": ["analytics/posthog"]
    }
  ],
  "footerSocials": {
    "github": "https://github.com/mintlify",
    "discord": "https://discord.gg/MPNgtSZkgK",
    "twitter": "https://twitter.com/mintlify"
  }
}

​Properties

​Example mint.json

Properties

Example `mint.json`