Skip to content
AWFixer's Docs

Configuration

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

Identity

Section titled “Identity”

Set the name, theme, and visual identity of your site.

{
  "name": "Acme Docs",
  "theme": "mint",
  "favicon": "/favicon.svg",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  }
}

Your project name. Appears in the browser tab title and site metadata.

The visual theme. Options: mint, maple, willow, sequoia, prism.

Path to your favicon. SVG recommended for crisp rendering at all sizes.

Logo shown in light mode.

Logo shown in dark mode.

URL the logo links to.

Colors

Section titled “Colors”
{
  "colors": {
    "primary": "#16A34A",
    "light": "#07C983",
    "dark": "#15803D"
  }
}

Primary brand color. Used for highlights, active states, and accents in light mode.

Primary color for dark mode.

Used for buttons and important interactive elements.

Override the default page background color.

Background hex color in light mode.

Background hex color in dark mode.

Section titled “Navbar”

Configure the top navigation bar links and primary call-to-action.

{
  "navbar": {
    "links": [{ "label": "Support", "href": "mailto:support@example.com" }],
    "primary": {
      "type": "button",
      "label": "Dashboard",
      "href": "https://dashboard.example.com"
    }
  }
}

Text links displayed in the top navigation bar.

Display text for the link.

URL the link points to.

The prominent call-to-action in the top-right corner.

button renders a CTA button. github renders a star count badge.

Button label. Required when type is button.

URL the button or badge links to.

Section titled “Navigation”

Organize your pages into tabs and groups. See the Navigation guide for full details.

{
  "navigation": {
    "tabs": [
      {
        "tab": "Guides",
        "groups": [
          {
            "group": "Getting started",
            "pages": ["index", "quickstart"]
          }
        ]
      }
    ],
    "global": {
      "anchors": [
        {
          "anchor": "Blog",
          "href": "https://example.com/blog",
          "icon": "newspaper"
        }
      ]
    }
  }
}

Contextual toolbar

Section titled “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.

{
  "contextual": {
    "options": ["copy", "view", "claude", "mcp", "cursor", "vscode"]
  }
}
Section titled “Footer”
{
  "footer": {
    "socials": {
      "x": "https://x.com/yourhandle",
      "github": "https://github.com/yourorg",
      "linkedin": "https://linkedin.com/company/yourco"
    }
  }
}

Social links shown in the footer. Supported keys: x, github, linkedin, discord, slack, facebook, instagram, website.