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 of your company or project. Used for the global title.
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. Path to the logo in light mode. For example: /path/to/logo.svg
Path to the logo in dark mode. For example: /path/to/logo.svg
Where clicking on the logo links you to
Path to the favicon image. For example: /path/to/favicon.svg
Hex color codes for your global theme The primary color. Used most often for highlighted content, section
headers, accents, in light mode
The primary color for dark mode. Used most often for highlighted content,
section headers, accents, in dark mode
The primary color for important buttons
The color of the background in both light and dark mode The hex color code of the background in light mode
The hex color code of the background in dark mode
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.
Set a decorative background. styling
"gradient" | "grid" | "windows"
The style of the decorative background.
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. The font family name. Custom fonts and all Google
Fonts are supported. e.g. “Open Sans”,
“Playfair Display” The font weight. Precise values such as 560 are also supported for
variable fonts. Check under the Styles section for your Google Font for
the available weights.
The URL to the font file. Can be used to specify a font that is not from
Google Fonts.
The font format. Required if using a custom font source (url).
Customize the dark mode toggle. 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.
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: Only Dark Mode
Only Light Mode
"modeToggle" : { "default" : "dark" , "isHidden" : true }
Customize the styling of components within the sidebar. items
"container" | "card" | "border" | "undecorated"
default: "container"
The styling of the navigation item.
Styling configurations for the topbar. styling
"default" | "gradient"
default: "default"
The styling of the navigation item.
The location of the search bar entry.
The style of the rounded edges.
Structure An array of groups with all the pages within that group The relative paths to the markdown files that will serve as pages. Note: groups are recursive, so to add a sub-folder add another group object in the page array.
The Fontawesome icon for the group. Note: this only applies to sub-folders. The type of Fontawesome icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin Array of names and urls of links you want to include in the topbar The url once you click on the button. Example: https://mintlify.com/contact
Show Topbar Call to Action
type
link or github
default: "link"
Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
If type is a link: What the button links to. If type is a github: Link to the repository to load GitHub information from.
Text inside the button. Only required if type is a link.
style
"pill" | "roundedRectangle"
The style of the button.
Whether to display the arrow
Array of version names. Only use this if you want to show different versions
of docs with a dropdown in the navigation bar.
An array of the anchors, includes the icon, color, and url. The Font Awesome icon used to feature the anchor. Example: comments The name of the anchor label. Example: Community
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.
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.
Used if you want to hide an anchor until the correct docs version is selected.
Pass true if you want to hide the anchor until you directly link someone to docs inside it.
One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”
Override the default configurations for the top-most anchor. Note: if you have
tabs configured, this does not apply. name
string
default: "Documentation"
The name of the top-most anchor
icon
string
default: "book-open"
Font Awesome icon.
One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”
An array of navigational tabs. Example: "tabs" : [ { "name" : "Writing Content" , "url" : "content" }, { "name" : "API References" , "url" : "api-playground" } ] The name of the tab label.
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.
Pass true if you want to hide the tab until you directly link someone to docs inside it.
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" } One of the following values website, facebook, x, youtube, discord, slack, github, linkedin, instagram, hacker-news Example: x
The URL to the social platform. Example: https://x.com/mintlify
Configurations to enable feedback buttons Enables a rating system for users to indicate whether the page has been helpful
Enables a button to allow users to suggest edits via pull requests
Enables a button to allow users to raise an issue about the documentation
Configurations to change the search prompt prompt
string
default: "undefined"
Set the prompt for the search bar. Default is Search...
API Configurations Configuration for API settings. Learn more about API pages at API Components . 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.
method
"bearer" | "basic" | "key"
The authentication strategy used for all API endpoints.
The name of the authentication parameter used in the API playground. If method is basic, the format should be [usernameName]:[passwordName]
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.
Configurations for the API playground mode
"show" | "simple" | "hide"
default: "show"
Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity simple Learn more at the playground guides By default, API playground requests are proxied by Mintlify. This setting can be used to disable this behavior. Required for select request types, such as file uploads.
Configurations for API requests Configurations for the auto-generated API request examples An array of strings that determine the order of the languages of the auto-generated request examples. You can either define custom languages utilizing x-codeSamples or use our default languages which include bash, python, javascript, php, go, java Configurations for the param fields in the API Playground expanded
"all" | "topLevel" | "topLevelOneOfs" | "none"
default: "none"
The default expanded state of expandable options in the API playground. "all" - every expandable component is expanded"topLevel" - every top-level expandable component is expanded"topLevelOneOfs" - every top-level oneOf type is expanded"none" - every expandable component is closed (default behavior)
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"
Integrations Configurations to add third-party integrations (excluding analytics integrations) Enables Intercom widget on docs site. The value should be your Intercom App ID.
Enables Frontchat widget on docs site. The value should be your Frontchat App ID.
Configurations to add third-party analytics integrations. See full list of
supported analytics here . Redirects An array of paths you want to configure to permanently redirect to another path Example: "redirects" : [ { "source" : "/source/path" , "destination" : "/destination/path" } ] The path that you want to redirect from. Example: /source
The path that you want to redirect to. Example: /destination
Search Engine Optimization Settings for Search Engine Optimization. Example: "seo" : { "indexHiddenPages" : true } Enables indexing pages not included in navigation.
Example mint.json Click on the following dropdown to view a sample configuration file
View Example Configuration
{ "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:support@mintlify.com" } ], "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-playground/overview" , "api-playground/configuration" ] }, { "group" : "Settings" , "pages" : [ "settings/global" , "settings/page" ] }, { "group" : "Analytics" , "pages" : [ "analytics/posthog" ] } ], "footerSocials" : { "github" : "https://github.com/mintlify" , "discord" : "https://discord.gg/MPNgtSZkgK" , "x" : "https://x.com/mintlify" }, "integrations" : { "intercom" : "abcdefz" , "frontchat" : "abcdez" } } More Customization Learn more about how to further customize your docs with custom CSS and JS in
Custom Scripts . 
