- Global Settings (mint.json)
Global Settings (mint.json)
Mintlify gives you complete control over the look and feel of your documentation using the mint.json file
Every Mintlify site needs a mint.json
file with the core configuration settings. Learn more about the properties or from an example
Properties
Name of your project. Used for the global title.
Example: mintlify
An array of groups with all the pages within that group
Path to logo image or object with path to “light” and “dark” mode logo images
Path to the favicon image
Hex color codes for your global theme
Array of name
s and url
s of links you want to include in the topbar
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
.


Override the default configurations for the top-most anchor.
Configuration for API settings. Learn more about API pages at API Components.
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"
}
Whether or not to hide the edit suggestion and raise and issue buttons at the
top of every page. Defaults to false
Customize the dark mode toggle.
Example mint.json
Click on the following dropdown to view a sample configuration file