Global Settings
Customize 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
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 favicon image. For example: /path/to/favicon.svg
Hex color codes for your global theme
The global layout style of the documentation.
Set a decorative background.
Set a custom background image to be displayed behind every page.
Custom fonts. Apply globally or set different fonts for headings and the body text.
Customize the dark mode toggle.
Customize the styling of components within the sidebar.
Styling configurations for the topbar.
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
Array of names and urls 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. Note: if you have tabs configured, this does not apply.
An array of navigational tabs.
Example:
"tabs": [
{
"name": "Writing Content",
"url": "content"
},
{
"name": "API References",
"url": "api-playground"
}
]
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" }
]
}
]
}
Configurations to enable feedback buttons
Configurations to change the search prompt
API Configurations
Configuration for API settings. Learn more about API pages at API Components.
A string or an array of strings of URL(s) or relative path(s) pointing to your OpenAPI file.
Examples:
Integrations
Configurations to add third-party integrations (excluding analytics integrations)
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"
}
]
Search Engine Optimization
Settings for Search Engine Optimization.
Example:
"seo": {
"indexHiddenPages": true
}
Example mint.json
Click on the following dropdown to view a sample configuration file
More Customization
Learn more about how to further customize your docs with custom CSS and JS in Custom Scripts.
Was this page helpful?