> ## Documentation Index
> Fetch the complete documentation index at: https://omer-d3c826d3.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> Customize your site with the `docs.json` file

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.

```json docs.json theme={null}
{
  "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.

**logo** `object`

**Logo**

**light** `string`

Logo shown in light mode.

**dark** `string`

Logo shown in dark mode.

**href** `string` (default: /)

URL the logo links to.

## Colors

```json docs.json theme={null}
{
  "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.

**Background**

**light** `string`

Background hex color in light mode.

**dark** `string`

Background hex color in dark mode.

## Navbar

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

```json docs.json theme={null}
{
  "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.

**Link**

**label** `string`

Display text for the link.

**href** `string`

URL the link points to.

**navbar.primary** `object`

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

**Primary**

**type** `"button" | "github"`

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

**label** `string`

Button label. Required when type is `button`.

**href** `string`

URL the button or badge links to.

## Navigation

Organize your pages into tabs and groups. See the [Navigation](/essentials/navigation) guide for full details.

```json docs.json theme={null}
{
  "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](/agent-ready/contextual) for the full list of options.

```json docs.json theme={null}
{
  "contextual": {
    "options": ["copy", "view", "claude", "mcp", "cursor", "vscode"]
  }
}
```

## Footer

```json docs.json theme={null}
{
  "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`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.