Mintlify gives you complete control over the look and feel of your documentation using the docs.json file
Every Mintlify site needs a docs.json file with the core configuration settings. Learn more about the properties below.
Properties
string
required
Name of your project. Used for the global title.Example: mintlify
Navigation[]
required
An array of groups with all the pages within that group
Show Navigation
string
The name of the group.Example: Settings
string[]
The relative paths to the markdown files that will serve as pages.Example: ["customization", "page"]
string or object
Path to logo image or object with path to “light” and “dark” mode logo images
Show Logo
string
Path to the logo in light mode
string
Path to the logo in dark mode
string
default:"/"
Where clicking on the logo links you to
string
Path to the favicon image
Colors
Hex color codes for your global theme
Show Colors
string
required
The primary color. Used for most often for highlighted content, section
headers, accents, in light mode
string
The primary color for dark mode. Used for most often for highlighted
content, section headers, accents, in dark mode
string
The primary color for important buttons
object
The color of the background in both light and dark mode
Show Object
string
required
The hex color code of the background in light mode
string
required
The hex color code of the background in dark mode
TopbarLink[]
Array of names and urls of links you want to include in the topbar
Show TopbarLink
string
The name of the button.Example: Contact us
string
The url once you click on the button. Example: https://mintlify.com/docs
Call to Action
Show Topbar Call to Action
"link" or "github"
default:"link"
Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
string
If link: What the button links to.If github: Link to the repository to load GitHub information from.
string
Text inside the button. Only required if type is a link.
string[]
Array of version names. Only use this if you want to show different versions
of docs with a dropdown in the navigation bar.
Anchor[]
An array of the anchors, includes the icon, color, and url.
Show Anchor
string
The Font Awesome icon used to feature the anchor.Example: comments
string
The name of the anchor label.Example: Community
string
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.
string
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.
string
Used if you want to hide an anchor until the correct docs version is selected.
boolean
default:"false"
Pass true if you want to hide the anchor until you directly link someone to docs inside it.
string
default:"duotone"
One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”
Object
Override the default configurations for the top-most anchor.
Show Object
string
default:"Documentation"
The name of the top-most anchor
string
default:"book-open"
Font Awesome icon.
string
default:"duotone"
One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”
Tabs[]
An array of navigational tabs.
Show Tabs
string
The name of the tab label.
string
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.
API
Configuration for API settings. Learn more about API pages at API Components.
Show API
string
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.
Auth
Show Auth
"bearer" | "basic" | "key"
The authentication strategy used for all API endpoints.
string
The name of the authentication parameter used in the API playground.If method is basic, the format should be [usernameName]:[passwordName]
string
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.
Playground
Configurations for the API playground
Show Playground
"show" | "simple" | "hide"
default:"show"
Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity simpleLearn more at the playground guides
boolean
Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.
This behavior will soon be enabled by default, at which point this field will be deprecated.
string | string[]
A string or an array of strings of URL(s) or relative path(s) pointing to your
OpenAPI file.Examples:
