Skip to main content
Every Mintlify site is configured through a docs.json file in your project root. Changes take effect immediately in local preview.

​
Identity

Set the name, theme, and visual identity of your site.
docs.json
{
  "name": "Acme Docs",
  "theme": "mint",
  "favicon": "/favicon.svg",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  }
}
​
name
string
required
Your project name. Appears in the browser tab title and site metadata.
​
theme
string
The visual theme. Options: mint, maple, willow, sequoia, prism.
​
favicon
string
Path to your favicon. SVG recommended for crisp rendering at all sizes.

​
Colors

docs.json
{
  "colors": {
    "primary": "#16A34A",
    "light": "#07C983",
    "dark": "#15803D"
  }
}
​
colors.primary
string
required
Primary brand color. Used for highlights, active states, and accents in light mode.
​
colors.light
string
Primary color for dark mode.
​
colors.dark
string
Used for buttons and important interactive elements.
​
colors.background
object
Override the default page background color.
Configure the top navigation bar links and primary call-to-action.
docs.json
{
  "navbar": {
    "links": [
      { "label": "Support", "href": "mailto:support@example.com" }
    ],
    "primary": {
      "type": "button",
      "label": "Dashboard",
      "href": "https://dashboard.example.com"
    }
  }
}
​
navbar.links
array
Text links displayed in the top navigation bar.
​
navbar.primary
object
The prominent call-to-action in the top-right corner.
Organize your pages into tabs and groups. See the Navigation guide for full details.
docs.json
{
  "navigation": {
    "tabs": [
      {
        "tab": "Guides",
        "groups": [
          {
            "group": "Getting started",
            "pages": ["index", "quickstart"]
          }
        ]
      }
    ],
    "global": {
      "anchors": [
        {
          "anchor": "Blog",
          "href": "https://example.com/blog",
          "icon": "newspaper"
        }
      ]
    }
  }
}

​
Contextual toolbar

The contextual toolbar floats on every page and gives readers one-click access to AI tools and integrations. See Contextual toolbar for the full list of options.
docs.json
{
  "contextual": {
    "options": ["copy", "view", "claude", "mcp", "cursor", "vscode"]
  }
}
docs.json
{
  "footer": {
    "socials": {
      "x": "https://x.com/yourhandle",
      "github": "https://github.com/yourorg",
      "linkedin": "https://linkedin.com/company/yourco"
    }
  }
}
​
footer.socials
object
Social links shown in the footer. Supported keys: x, github, linkedin, discord, slack, facebook, instagram, website.