Global Settings - Mintlify

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

Properties

Styling

name

string

required

Name of your company or project. Used for the global title.

logo

string or Logo

Path to logo image or object with path to “light” and “dark” mode logo images, and where the logo links to. SVG format is recommended. It does not pixelate and the file size is generally smaller.

favicon

string

Path to the favicon image. For example: /path/to/favicon.svg

colors

Colors

Hex color codes for your global theme

theme

"venus" | "quill" | "prism"

A preset theme configuration that changes the look and feel of the project. A theme is a set of default styling configurations. Examples: Venus, Quill, Prism

layout

"topnav" | "sidenav" | "solidSidenav"

default: "topnav"

The global layout style of the documentation.

background

Background

Set a decorative background.

backgroundImage

string

Set a custom background image to be displayed behind every page.

font

FontDetailsType | { headings?: FontDetailsType, body?: FontDetailsType }

Custom fonts. Apply globally or set different fonts for headings and the body text.

Example:

"font": {
  "headings": {
    "family": "Roboto"
  },
  "body": {
    "family": "Oswald"
  }
}

modeToggle

ModeToggle

Customize the dark mode toggle.

sidebar

Sidebar

Customize the styling of components within the sidebar.

topbar

Topbar

Styling configurations for the topbar.

The location options for the search bar.

rounded

"default" | "sharp"

The style of the rounded edges.

codeBlock

CodeBlock

The style of the code block.

Structure

An array of groups with all the pages within that group

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.

Versions can be leveraged for localization. You can store translated content under a version, and once you specify the locale any fixed text in Mintlify, such as ‘Was this page helpful?’, will automatically be translated based on the locale. We currently support localization in English, Chinese, Spanish, French, Japanese, and Portuguese.

Localization applies to the UI and fixed assets in the docs, such as “was this page helpful”.

For more information, please refer to our versioning documentation.

Example:

anchors

Anchor[]

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

topAnchor

Anchor

Override the default configurations for the top-most anchor. Note: if you have tabs configured, this does not apply.

tabs

Tabs[]

An array of navigational tabs.

Example:

"tabs": [
  {
    "name": "Writing Content",
    "url": "content"
  },
  {
    "name": "API References",
    "url": "api-playground"
  }
]

footer

{ socials?: FooterSocials, links?: FooterLinksColumn[] }

An object to configure the footer with socials and links. Example:

"footer": {
  "socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" },
  "links": [
    {
      "title": "Column 1",
      "links": [
        { "label": "Column 1 Link 1", "url": "https://mintlify.com" },
        { "label": "Column 1 Link 2", "url": "https://mintlify.com" }
      ]
    },
    {
      "title": "Column 2",
      "links": [
        { "label": "Column 2 Link 1", "url": "https://mintlify.com" },
        { "label": "Column 2 Link 2", "url": "https://mintlify.com" }
      ]
    }
  ]
}

feedback

Feedback

Configurations to enable feedback buttons

Configurations to change the search prompt

API Configurations

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:

Integrations

integrations

Integrations

Configurations to add third-party integrations (excluding analytics integrations)

analytics

Analytics

Configurations to add third-party analytics integrations. See full list of supported analytics here.

Redirects

redirects

Redirect[]

An array of paths you want to configure to permanently redirect to another path

Example:

"redirects": [
  {
    "source": "/source/path",
    "destination": "/destination/path"
  }
]

Search Engine Optimization

seo

SEO

Settings for Search Engine Optimization.

Example:

"seo": {
  "indexHiddenPages": true
}

Example `mint.json`

Click on the following dropdown to view a sample configuration file

{
  "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://mintlify.com/start"
  },
  "anchors": [
    {
      "name": "API Components",
      "icon": "rectangle-terminal",
      "color": "#f59f0b",
      "url": "api-components"
    },
    {
      "name": "Community",
      "icon": "comments",
      "color": "#2564eb",
      "url": "https://mintlify.com/community"
    }
  ],
  "navigation": [
    {
      "group": "Getting Started",
      "pages": ["introduction", "quickstart"]
    },
    {
      "group": "API Components",
      "pages": ["api-playground/overview", "api-playground/configuration"]
    },
    {
      "group": "Settings",
      "pages": ["settings/global", "settings/page"]
    },
    {
      "group": "Analytics",
      "pages": ["analytics/posthog"]
    }
  ],
  "footerSocials": {
    "github": "https://github.com/mintlify",
    "slack": "https://mintlify.com/community",
    "x": "https://x.com/mintlify"
  },
  "integrations": {
    "intercom": "APP_ID",
    "frontchat": "CHAT_ID"
  }
}

More Customization

Learn more about how to further customize your docs with custom CSS and JS in Custom Scripts.

Getting Started

Writing Content

API References

Configurations

Advanced

​Properties

​Styling

​Structure

​API Configurations

​Integrations

​Redirects

​Search Engine Optimization

​Example mint.json

​More Customization

Properties

Styling

Structure

API Configurations

Integrations

Redirects

Search Engine Optimization

Example `mint.json`

More Customization