Global Settings

Every Mintlify site needs a docs.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

Navigation

groupstring

The name of the group.

Example: Settings

pagesstring[]

The relative paths to the markdown files that will serve as pages.

Example: ["customization", "page"]

logostring or object

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

Logo

lightstring

Path to the logo in light mode

darkstring

Path to the logo in dark mode

hrefstring

Where clicking on the logo links you to

faviconstring

Path to the favicon image

colorsColors

Hex color codes for your global theme

Colors

primarystringrequired

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

lightstring

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

darkstring

The primary color for important buttons

backgroundobject

The color of the background in both light and dark mode

Object

lightstringrequired

The hex color code of the background in light mode

darkstringrequired

The hex color code of the background in dark mode

topbarLinksTopbarLink[]

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

TopbarLink

namestring

The name of the button.

Example: Contact us

urlstring

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

topbarCtaButtonCall to Action

Topbar Call to Action

type"link" or "github"

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

urlstring

If link: What the button links to.

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

namestring

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

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.

Anchor

iconstring

The Font Awesome icon used to feature the anchor.

Example: comments

namestring

The name of the anchor label.

Example: Community

urlstring

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.

colorstring

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.

versionstring

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

isDefaultHiddenboolean

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

iconTypestring

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

topAnchorObject

Override the default configurations for the top-most anchor.

Object

namestring

The name of the top-most anchor

iconstring

Font Awesome icon.

iconTypestring

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

tabsTabs[]

An array of navigational tabs.

Tabs

namestring

The name of the tab label.

urlstring

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.

apiAPI

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

API

baseUrlstring

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.

authAuth

Auth

method"bearer" | "basic" | "key"

The authentication strategy used for all API endpoints.

namestring

The name of the authentication parameter used in the API playground.

If method is basic, the format should be [usernameName]:[passwordName]

inputPrefixstring

The default value that's designed to be a prefix for the authentication input field.

E.g. If an inputPrefix of AuthKey would inherit the default input result of the authentication field as AuthKey.

playgroundPlayground

Configurations for the API playground

Playground

mode"show" | "simple" | "hide"

Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity simple

Learn more at the playground guides

maintainOrderboolean

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

aviso

This behavior will soon be enabled by default, at which point this field will be deprecated.

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

"openapi": "/openapi.json"

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

FooterSocials

[key]string

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

Example: x

propertystring

The URL to the social platform.

Example: https://x.com/mintlify

feedbackFeedback

Configurations to enable feedback buttons

Feedback

suggestEditboolean

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

raiseIssueboolean

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

modeToggleModeToggle

Customize the dark mode toggle.

ModeToggle

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.

isHiddenboolean

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
}

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

backgroundImagestring

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

Properties​

Properties